v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB

Appointment Custom Field

List Appointment Custom Fields

Retrieve a list of appointment custom fields

get/appointment_custom_field

Query parameters

appointment_idstring

Appointment ID

custom_field_idstring

Custom field ID

created_atstring

Appointment custom field creation date

updated_atstring

Latest update

organisation_idstring

Organisation ID

keystring

Appointment custom field key

valuestring

Value of appointment custom field

date_valuestring

Date value

string_valuestring

String value

number_valuestring

Number value

boolean_valuestring

Boolean value

datetime_valuestring

Datetime value

string_list_valuestring

String list value

selectstring

Filtering Columns

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Response

OK

appointment_idstring uuid

Appointment ID

custom_field_idstring uuid

Custom field ID

created_atstring timestamp with time zone

Appointment custom field creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

keystring text nullable

Appointment custom field key

valuestring text nullable

Value of appointment custom field

date_valuestring date nullable

Date value

string_valuestring text nullable

String value

number_valuenumber nullable

Number value

boolean_valueboolean nullable

Boolean value

datetime_valuestring timestamp with time zone nullable

Datetime value

string_list_valuestring[] nullable

String list value