Retrieve a list of customers

get

https://api.zenbooker.com/v1/customers

Returns a list of all customers. Optionally search or filter the customers returned using the query parameters below.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sort_order

string

enum

Defaults to ascending

Allowed:

created_before

date

Returns customers created before this datetime

created_after

date

Returns customers created after this datetime

name

string

Search for customers by their name

string

Search for customers by their email

phone

string

Search for customers by a phone number

location

string

Search for customers with default addresses around a geographical location. Location can be an arbitrary string that will be geocoded into a geographical location. For example Silver Spring, MD or 20901

radius

int32

If searching for customers around a location, provide the radius in miles to search around

cursor

int32

Pagination start

limit

int32

The maximum number of results to return. If not specified, defaults to 20. Max is 100.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400