Customers

Get customers

The Get Customers API retrieves a paginated list of customers based on specified filters. This API allows searching, filtering by country and state, and sorting the results.

get/v1/customers

Query parameters

search_querystring nullable

Search term to filter customers by name or other details

Search term to filter customers by name or other details

Country code in ISO 3166-1 alpha-2 format (e.g., 'US')

statestring nullable

State or province code to filter customers

State or province code to filter customers

source__instring nullable

Filter customers by source (comma-separated)

Filter customers by source (comma-separated)

connection_id__instring nullable

Filter customers by connection ID (comma-separated)

Filter customers by connection ID (comma-separated)

order_bystring nullable

Comma-separated list of fields to sort results by.

Comma-separated list of fields to sort results by.

pageinteger

Page number

Page number

sizeinteger

Page size

Page size

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

The unique identifier for the organization making the request

Response

Successfully retrieved customers

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Changes