Customers

Query customers

Use when listing or searching customers (e.g. admin CRM or reporting). Returns a paginated list; supports filtering and sorting.

post/customers/search

Request body

customer_idsstring[]

emailstring

end_timestring date-time

expandstring

external_idstring

external_idsstring[]

limitinteger

metadataobject

offsetinteger

order'asc' | 'desc'

start_timestring date-time

status'published' | 'deleted' | 'archived'

Response

Changes

Changed in 5 of the 12 revisions of this API.21112

Jun 29, 2026cef2964c102c2See the full diff
- ○
  added the optional property items/items/integrations/items/metadata to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/timezone to the response with the 200 status
  response-optional-property-added
May 18, 2026f62d8a5fe7cf4See the full diff
- ●
  removed the optional property details from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 500 status
  response-optional-property-removed
- ●
  added the new too_many_requests enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new too_many_requests enum value to the code response property for the response status 500
  response-property-enum-value-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 18, 20260cb3425d65801See the full diff
- ○
  added the new optional request property metadata
  new-optional-request-property
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 6, 20264ded3711f40178See the full diff
- ●
  removed the request property parent_customer_ids
  request-property-removed
- ●
  removed the optional property error from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property error from the response with the 500 status
  response-optional-property-removed
- ●
  removed the optional property items/items/parent_customer from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/items/parent_customer_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property success from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property success from the response with the 500 status
  response-optional-property-removed
- ○
  added the optional property code to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property http_status_code to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property http_status_code to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 500 status
  response-optional-property-added
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 4, 2026d1860fe0ee6721See the full diff
- ▲
  the end_time request property type/format changed from string/ to string/date-time
  request-property-type-changed
- ▲
  the start_time request property type/format changed from string/ to string/date-time
  request-property-type-changed
- ○
  added the optional property items/items/integrations to the response with the 200 status
  response-optional-property-added
This revision also has 223 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history