List customers
Customers
List customers
Returns a paginated list of customers in the workspace.
GET
List customers
Authorizations
Use header Authorization: Token <api_token>.
API tokens are obtained from the Piriod dashboard.
Headers
Workspace (account) identifier. Required for every request.
Whether to operate against test-mode data. Defaults to false.
Query Parameters
Page number to retrieve (1-indexed).
Required range:
x >= 1Number of items per page.
Required range:
1 <= x <= 100Field to sort results by. Prefix with - for descending order
(e.g. -created).
Filter by country ID.
Use lookups: created__gte, created__lte.
Filter by linked subscription ID.
Filter by linked source ID.
Response
Paginated customer list.
