List customers
Customers
List customers
Fetch a paginated list of customers.
GET
List customers
Returns a paginated page of customers. See
Pagination for the common query parameter
contract.
Each
Query parameters
integer
default:"1"
integer
default:"10"
Page size, max 100.
string
Column to sort by. Common values:
id, displayName,
submittedDate, activationDate.string
ASC or DESC.string
Point-lookup by partner-supplied externalId. Returns a single-item
page if found, or an empty page (
items: [], total: 0) if not.
externalId uniqueness is enforced upstream, so at most one match is
ever returned. Pagination params are still honoured for response
shape but don’t affect the result.Examples
Response
items entry has the same shape as the
customer object.
