v1
latestOpenAPI 3.0.02026-07-12414931.1 MBCustomers
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
Search term to filter customers by name or other details
Search term to filter customers by name or other details
countryCountryCodeEnum[]
Country code in ISO 3166-1 alpha-2 format (e.g., 'US')
Country code in ISO 3166-1 alpha-2 format (e.g., 'US')
statestring
State or province code to filter customers
State or province code to filter customers
source__instring
Filter customers by source (comma-separated)
Filter customers by source (comma-separated)
order_bystring
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
Response
Successfully retrieved customers