Get All Bookings By Account ID

get

https://json-api.appointedd.com/v2/accounts/{accountId}/bookings

Get a paginated view of all Appointedd bookings in an account with a specific ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

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

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 bookings that belong to any of the given account IDs.

filter[accountIds]

filter[customerIds]

array of strings

Returns any bookings that belong to any of the given customer IDs.

filter[customerIds]

filter[resourceIds]

array of strings

Returns any bookings that belong to any of the given resource IDs.

filter[resourceIds]

filter[eventIds]

array of strings

Returns any bookings that belong to any of the given event IDs.

filter[eventIds]

filter[payments][externalIds]

array of strings

Returns any bookings that have a payment that references any of the given external IDs provided by the payment provider used for the payment.

filter[payments][externalIds]

filter[state]

string

enum

Returns any bookings that have a state set to the given value.

Allowed:

filter[start][after]

date-time

Returns any bookings that start after the given date and time (inclusive).

filter[start][before]

date-time

Returns any bookings that start before the given date and time (inclusive).

filter[end][after]

date-time

Returns any bookings that end after the given date and time (inclusive).

filter[end][before]

date-time

Returns any bookings that end before the given date and time (inclusive).

filter[created][after]

date-time

Returns any bookings that were created after the given date and time (inclusive).

filter[created][before]

date-time

Returns any bookings that were created before the given date and time (inclusive).

filter[updated][after]

date-time

Returns any bookings that were updated after the given date and time (inclusive).

filter[updated][before]

date-time

Returns any bookings that were updated before the given date and time (inclusive).

includes[relationship][resources]

enum

Whether to include resources in the relationships.

includes[relationship][invoices]

enum

Whether to include invoice payment data in the attributes.

Responses

Language

Credentials

OAuth2

Loading…

Response

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

application/json

200OK

401Unauthorized