List Appointment Details - Hellomateo API Documentation

[ { "id": "random uuid", "created_at": "now()", "updated_at": "now()", "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "description": "<string>", "external_id": "<string>", "status_key": "<string>", "type_key": "<string>", "assignee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "start_time": "<string>", "end_time": "<string>", "confirmed_at": "<string>", "cancelled_at": "<string>", "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" } ]

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

string

Appointment ID

created_at

string

Creation date

updated_at

string

Latest update

organisation_id

string

Organisation ID

name

string

Name of the appointment

description

string

Description of the appointment

external_id

string

External ID

status_key

string

Status Key

type_key

string

Type Key

assignee_id

string

Assignee ID

contact_id

string

Contact ID

start_time

string

Start time of the appointment

end_time

string

End time of the appointment

confirmed_at

string

Confirmed at timestamp

cancelled_at

string

Cancelled at timestamp

location_id

string

Location ID

select

string

Filtering Columns

order

string

Ordering. Allowed Fields: start_time

offset

string

Limiting and Pagination

limit

string

Limiting and Pagination

Response

200 - application/json

string<uuid>

default:random uuid

Appointment ID

created_at

string<timestamp with time zone>

default:now()

Creation date

updated_at

string<timestamp with time zone>

default:now()

Latest update

organisation_id

string<uuid>

Organisation ID

name

string<text>

Name of the appointment

description

string<text> | null

Description of the appointment

external_id

string<text> | null

External ID

status_key

string<text>

Status Key

type_key

string<text>

Type Key

assignee_id

string<uuid> | null

Assignee ID

contact_id

string<uuid>

Contact ID

start_time

string<timestamp with time zone>

Start time of the appointment

end_time

string<timestamp with time zone> | null

End time of the appointment

confirmed_at

string<timestamp with time zone> | null

Confirmed at timestamp

cancelled_at

string<timestamp with time zone> | null

Cancelled at timestamp

location_id

string<uuid> | null

Location ID

{key}

Example:

"your string custom field"