List customers

Returns a paginated list of customers scoped to the caller account, with optional type and text search.

get/api/v1/customers

Query parameters

typestring

qstring

pagenumber

limitnumber

sortBystring

sortOrderstring

Response

Paginated list of customers.

Example response

{
  "meta": {
    "total": 42,
    "pages": 3,
    "current_page": 1,
    "next_page": 2,
    "limit": 20
  }
}

Changes

Changed in 2 of the 9 revisions of this API.17616

Jul 7, 2026a3b4750a505f16See the full diff
- ○
  added the new optional query request parameter limit
  new-optional-request-parameter
- ○
  added the new optional query request parameter page
  new-optional-request-parameter
- ○
  added the new optional query request parameter q
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortBy
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortOrder
  new-optional-request-parameter
- ○
  added the new optional query request parameter type
  new-optional-request-parameter
- ○
  added the required property data/items/birth_date to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/created_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/document to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/email to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/metadata to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/name to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/phone to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/type to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/updated_at to the response with the 200 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 7, 202684194c31ab85176See the full diff
- ▲
  removed the required property data/items/avg_ticket from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/birth_date from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/created_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/document from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/email from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/first_order_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/last_order_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/origin from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/phone from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/phone_is_whatsapp from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/social_name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/total_orders from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/total_spent from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/type from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/updated_at from the response with the 200 status
  response-required-property-removed
- ●
  deleted the query request parameter limit
  request-parameter-removed
- ●
  deleted the query request parameter page
  request-parameter-removed
- ●
  deleted the query request parameter q
  request-parameter-removed
- ●
  deleted the query request parameter sortBy
  request-parameter-removed
- ●
  deleted the query request parameter sortOrder
  request-parameter-removed
- ●
  deleted the query request parameter type
  request-parameter-removed
This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history