Skip to main content
List Appointment Custom Fields

Authorizations

Authorization
string
header
required

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

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Query Parameters

appointment_id
string

Appointment ID

custom_field_id
string

Custom field ID

created_at
string

Appointment custom field creation date

updated_at
string

Latest update

organisation_id
string

Organisation ID

key
string

Appointment custom field key

value
string

Value of appointment custom field

date_value
string

Date value

string_value
string

String value

number_value
string

Number value

boolean_value
string

Boolean value

datetime_value
string

Datetime value

string_list_value
string

String list value

select
string

Filtering Columns

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

200 - application/json

OK

appointment_id
string<uuid>

Appointment ID

custom_field_id
string<uuid>

Custom field ID

created_at
string<timestamp with time zone>
default:now()

Appointment custom field creation date

updated_at
string<timestamp with time zone>
default:now()

Latest update

organisation_id
string<uuid>

Organisation ID

key
string<text> | null

Appointment custom field key

value
string<text> | null

Value of appointment custom field

date_value
string<date> | null

Date value

string_value
string<text> | null

String value

number_value
number<numeric> | null

Number value

boolean_value
boolean<boolean> | null

Boolean value

datetime_value
string<timestamp with time zone> | null

Datetime value

string_list_value
string[] | null

String list value