Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url https://api.salesive.com/api/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "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
  }
}
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.

Authorizations

​
Authorization
string
header
required

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

​
page
integer
default:1

1-based page number.

Required range: x >= 1
​
limit
integer
default:10

Items per page. Defaults to 10, capped at 100.

Required range: 1 <= x <= 100
​
search
string

Case-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.

​
status
integer
required

HTTP status code, echoed in the body.

​
success
boolean
required

Whether the request succeeded.

​
message
string
required

Human-readable result message.

​
data
object

Flat pagination metadata returned alongside the items array on list responses.