Get All Customers

get

https://json-api.appointedd.com/v2/customers

Get a paginated view of all Appointedd customers you have access to.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page[after]

string

^[a-f\d]{24}$

Unique identifier of the last document on the previous page when paginating forwards.

page[before]

string

^[a-f\d]{24}$

Unique identifier of the first document on the next page when paginating backwards.

page[first]

number

1 to 1000

Number of documents (between 1 - 1000) to return per page when paginating forwards.

page[last]

number

1 to 1000

Number of documents (between 1 - 1000) to return per page when paginating backwards.

filter[accountIds]

array of strings

Returns any customers that belong to any of the given account IDs.

filter[accountIds]

filter[query]

string

length between 1 and 2000

Returns any customers that match the given search term across email, first name, and last name fields.

filter[email]

string

length between 1 and 2000

Returns any customers with the exact given email address.

filter[email][matches]

string

length between 1 and 2000

Returns any customers that match the partial given email address.

filter[firstname]

string

length between 1 and 2000

Returns any customers with the exact given first name.

filter[firstname][matches]

string

length between 1 and 2000

Returns any customers that match the partial given first name.

filter[lastname]

string

length between 1 and 2000

Returns any customers with the exact given last name.

filter[lastname][matches]

string

length between 1 and 2000

Returns any customers that match the partial given last name.

filter[mobile]

string

length between 1 and 2000

Returns any customers with the exact given mobile phone number.

filter[tags][all]

array of strings

Returns any customers that have been tagged with all the given tags.

filter[tags][all]

filter[tags][any]

array of strings

Returns any customers that have been tagged with any of the given tags.

filter[tags][any]

filter[updatedSince]

string

Returns any customers that have been updated (or created if they have not been modified) after this date

Responses

200OK

401Unauthorized