Get Calendar Appointments

Use this endpoint to get a list of appointments for the specified calendar. The request range should not exceed 90 days.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The calendar's unique identifier

Query Params
string
Defaults to All

Enter one or more event types, separated by commas.
Only events with the specified types will be included in the response.
If no value is specified, the default value will be "All".
Possible values: All, Personal, InitialAppointment, MaterialDelivery, CrewLabor

integer

How many items to be returned at a time.

integer
Defaults to 0

The index of the first element to return

date
required

Start date for the query, in YYYY-MM-DD format.

date
required

End date for the query, in YYYY-MM-DD format.

uuid

The job's unique identifier

Responses

400

The query parameters are invalid.

404

The given calendar was not found.

416

The value for the pageStartIndex query parameter is outside the range of the return values.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json