Get All Schedules For The Service

get

https://json-api.appointedd.com/v2/services/{serviceId}/schedules

Get a paginated view of all schedules for the service.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

serviceId

string

required

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

The Id of the service the schedule is for.

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[available]

string

enum

Returns any available or non available schedules.

Allowed:

filter[active]

string

enum

When true, returns only active schedules (RecurringSchedules with no expiry or expiry in the future, and ExactSchedules ending in the future). When false, returns only inactive (expired) schedules.

Allowed:

filter[start][after]

date-time

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

filter[start][before]

date-time

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

filter[end][after]

date-time

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

filter[end][before]

date-time

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

filter[created][after]

date-time

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

filter[created][before]

date-time

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

filter[updated][after]

date-time

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

filter[updated][before]

date-time

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

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