Get Events For Patient

get/calendar/events-for-patient/{patient_id}

Request

Base URL
https://docs.decodahealth.com (the document declares no server; this is the origin it was published from)
Auth
none declared. Required headers: TENANT, API-KEY
TypeScript
https://skmtc.dev/decodahealth/apis/decoda-api/docs/calendar/events-for-patient/:patient_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

patient_idstring required

Query parameters

searchstring nullable

statusesEventStatus[] nullable

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

idstring required

titlestring required

startstring date-time required

endstring date-time required

type'APPOINTMENT' | 'SHIFT' | 'BLOCK' required

recurringEventIdstring nullable

iconsEventIcon[]

capacityinteger nullable

meetingLinkstring nullable

locationIdstring nullable

formCompletedboolean nullable

remindersstring[]

recurrenceModificationMode'this' | 'future' | 'all'

Enum representing the different modes for handling recurring event modifications Used when modifying recurring events to specify which occurrences should be affected

createdDatestring date-time nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.