Get Customers

get

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

Get one or more of the customers in your Appointedd organisation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

int32

Defaults to 10

Maximum number of customers to return per page. Must be a number between 1 and 100.

start

string

ID of the customer at the start of the page to return. You can use this to navigate to the next page of your current page by using the ID of the next property in your current page's response.

end

string

ID of the customer at the end of the page to return. You can use this to navigate to the previous page from your current page by using the ID of the prev property in your current page's response.

sort_by

string

enum

Defaults to natural

Property on the customers to sort with.

Allowed:

order_by

string

enum

Defaults to descending

Order to apply to the sorting used on the returned customers.

Allowed:

ids

array of strings

Restrict the resulting customers to only those that match one of these IDs.

ids

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