Skip to main content
GET
Fetch a calendar resource

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

calendar_resource_id
integer
required

The ID of the calendar resource to fetch

Response

200 - application/json

OK

Calendar resource represents a provider, room, or similar for a calendar.

calendar_id
integer
required

The ID of the calendar this resource belongs to.

can_client_double_book
boolean
required

Whether this resource can be double booked from the client side.

can_clinic_double_book
boolean
required

Whether this resource can be double booked from the clinic side.

clinic_id
integer
required

The ID of the clinic this resource belongs to.

clinic_user
ExternalCalendarResourceClinicUserSchema · object | null
required

The clinic user associated with this resource, if any.

created
string<date-time>
required

The datetime this object was created.

deleted
string<date-time> | null
required

The datetime this record was soft deleted.

id
integer
required

The unique identifier for this calendar resource object.

is_deleted
boolean
required

Whether this record is soft deleted or not.

is_imported
boolean
required

Whether this resource was created via import from the legacy PIMS.

modified
string<date-time>
required

The datetime this object was last modified; changes to related entities will not update this field.

name
string | null
required

The name of this resource.