GET/api/v1/customers

List customers

Returns every customer who has ordered from the merchant, with lifetime spend + order count.

Authorization

Requires the customers:read scope. See the auth guide for how to mint a token with the right scopes.

Parameters

Query parameters

Field	Type	Description
cursor optional	string	Pagination cursor returned in the previous response's `nextCursor`. Omit to start from the beginning. e.g. c1a2b3c4
limit optional	number	Page size. 1–100, default 25. e.g. 25

Response

A successful call returns 200 OK with the body shown to the right. Errors follow the standard envelope.

Request

curl 'https://theyutes.com/api/v1/customers' \
  -H 'Authorization: Bearer tyk_••••••••••••••••••••••••••••••••'

Response · 200 OK

json

{
  "data": [
    {
      "id": "cust_001",
      "name": "Adaeze Okonkwo",
      "email": "adaeze.okonkwo12@gmail.com",
      "phone": "+2348012345678",
      "totalSpent": 12450000,
      "orderCount": 3
    }
  ],
  "pagination": {
    "cursor": "c1a2b3c4",
    "limit": 25,
    "hasMore": false
  }
}