List a client's calendar events

Required scope: calendar:read.

Returns a client's calendar events, such as hearings and consultative exams, ordered by when they were added, newest first.

start and end are timestamps with a UTC offset. source_timezone is the time zone the event was recorded in, when known. For consultative exams, exam_types, exam_modality, reschedule_phone_number and exam_timezone come from the exam notice and are null when unknown or not applicable. Cancelled and rescheduled events stay in the list with an updated status.

GET /api/v2/clients/{id}/calendar-events
Bearer token scope calendar:read

Path parameters

· 1
id string required

Client ID.

Query parameters

· 2
limit integer · min: 1· max: 100· default: 50

Maximum number of items to return, from 1 to 100.

cursor string · min length: 1· max length: 4096

The page.next_cursor value from the previous page. Use it with the same filters; cursors expire after 24 hours.

Responses