List customers
curl --request GET \
--url https://api.salesive.com/api/v1/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.salesive.com/api/v1/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.salesive.com/api/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.salesive.com/api/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.salesive.com/api/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.salesive.com/api/v1/customers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 200,
"success": true,
"message": "Customers retrieved",
"data": {
"customers": [
{
"_id": "665a1f2c9b1e4a0012ab34cd",
"user": {
"_id": "6650aa11bb22cc33dd44ee55",
"name": "Ada Obi",
"email": "ada@example.com",
"avatar": "https://cdn.example.com/u/ada.png"
},
"shop": "664f0e2a1c2b3d4e5f6a7b8c",
"name": "Ada Obi",
"phone": "+2348012345678",
"email": "ada@example.com",
"lastActive": "2026-06-27T14:05:00.000Z",
"online": false,
"active": true,
"createdAt": "2026-05-01T09:00:00.000Z",
"updatedAt": "2026-06-27T14:05:00.000Z",
"avatar": "https://cdn.example.com/u/ada.png",
"id": "665a1f2c9b1e4a0012ab34cd"
}
],
"page": 1,
"pages": 4,
"total": 37
}
}{
"status": 401,
"success": false,
"message": "Authentication required",
"data": null
}{
"status": 403,
"success": false,
"message": "Insufficient scope",
"data": null
}Customers
List customers
Retrieve a paginated, searchable list of the store’s customers. Requires the READ_CUSTOMERS scope.
GET
/
customers
List customers
curl --request GET \
--url https://api.salesive.com/api/v1/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.salesive.com/api/v1/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.salesive.com/api/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.salesive.com/api/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.salesive.com/api/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.salesive.com/api/v1/customers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 200,
"success": true,
"message": "Customers retrieved",
"data": {
"customers": [
{
"_id": "665a1f2c9b1e4a0012ab34cd",
"user": {
"_id": "6650aa11bb22cc33dd44ee55",
"name": "Ada Obi",
"email": "ada@example.com",
"avatar": "https://cdn.example.com/u/ada.png"
},
"shop": "664f0e2a1c2b3d4e5f6a7b8c",
"name": "Ada Obi",
"phone": "+2348012345678",
"email": "ada@example.com",
"lastActive": "2026-06-27T14:05:00.000Z",
"online": false,
"active": true,
"createdAt": "2026-05-01T09:00:00.000Z",
"updatedAt": "2026-06-27T14:05:00.000Z",
"avatar": "https://cdn.example.com/u/ada.png",
"id": "665a1f2c9b1e4a0012ab34cd"
}
],
"page": 1,
"pages": 4,
"total": 37
}
}{
"status": 401,
"success": false,
"message": "Authentication required",
"data": null
}{
"status": 403,
"success": false,
"message": "Insufficient scope",
"data": null
}Returns the store’s customers sorted by most recent activity, with optional free-text search across name, email and phone. The store is bound to your app token server-side — never send a shop id.
Device & location info (
READ_CUSTOMER_ANALYTICS). With only READ_CUSTOMERS each customer
returns name, email, phone and activity. If your installation also holds READ_CUSTOMER_ANALYTICS,
each customer’s user.deviceInfo is included — device, browser, OS, IP address, approximate
location (ipInfo) and a device fingerprint. This is sensitive shopper PII; request the scope only
if you need it.Authorizations
Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.
Query Parameters
1-based page number.
Required range:
x >= 1Items per page. Defaults to 10, capped at 100.
Required range:
1 <= x <= 100Case-insensitive substring match against customer name, email or phone.
Response
Paginated list of customers.
Standard Salesive response envelope. The operation-specific payload is carried in data.
Was this page helpful?

