v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB

Appointment Details

List Appointment Details

Retrieve a list of appointment data with custom fields

get/appointment_details

Query parameters

idstring

Appointment ID

created_atstring

Creation date

updated_atstring

Latest update

organisation_idstring

Organisation ID

namestring

Name of the appointment

descriptionstring

Description of the appointment

external_idstring

External ID

status_keystring

Status Key

type_keystring

Type Key

assignee_idstring

Assignee ID

contact_idstring

Contact ID

start_timestring

Start time of the appointment

end_timestring

End time of the appointment

confirmed_atstring

Confirmed at timestamp

cancelled_atstring

Cancelled at timestamp

location_idstring

Location ID

selectstring

Filtering Columns

orderstring

Ordering. Allowed Fields: start_time

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Response

idstring uuid

Appointment ID

created_atstring timestamp with time zone

Creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

namestring text

Name of the appointment

descriptionstring text nullable

Description of the appointment

external_idstring text nullable

External ID

status_keystring text

Status Key

type_keystring text

Type Key

assignee_idstring uuid nullable

Assignee ID

contact_idstring uuid

Contact ID

start_timestring timestamp with time zone

Start time of the appointment

end_timestring timestamp with time zone nullable

End time of the appointment

confirmed_atstring timestamp with time zone nullable

Confirmed at timestamp

cancelled_atstring timestamp with time zone nullable

Cancelled at timestamp

location_idstring uuid nullable

Location ID