Get All External Events

get

https://json-api.appointedd.com/v2/calendar/external-events

Get a paginated view of all external calendar events from connected calendar systems.

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

filter[accountIds]

filter[resourceIds]

array of strings

Returns any calendar events that belong to any of the given resource IDs (bookable_id).

filter[resourceIds]

filter[customerIds]

array of strings

Returns any booking events that belong to any of the given customer IDs. Only applies to booking events.

filter[customerIds]

filter[eventIds]

array of strings

Returns any booking events that match the given event IDs (booking _id). Only applies to booking events.

filter[eventIds]

filter[start][after]

date-time

Returns any calendar events that start after the given date and time (inclusive). Uses UTC timezone.

filter[start][before]

date-time

Returns any calendar events that start before the given date and time (inclusive). Uses UTC timezone.

filter[end][after]

date-time

Returns any calendar events that end after the given date and time (inclusive). Uses UTC timezone.

filter[end][before]

date-time

Returns any calendar events that end before the given date and time (inclusive). Uses UTC timezone.

Responses

200OK

401Unauthorized

403Forbidden