Skip to main content
GET
List customers

Authorizations

X-Api-Key
string
header
required

Query Parameters

include_locations
boolean
default:false

If true, includes locations data for each customer.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

phone_number
string
default:""

Filter result by a specific phone number. Given that customer's phone numbers are unique, the result will contain at most a single customer object

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"