Skip to main content
GET
Fetch an appointment kind

Authorizations

Authorization
string
header
required

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

Path Parameters

appointment_kind_id
integer
required

The ID of the appointment kind to fetch

Response

200 - application/json

OK

Detailed information about an appointment kind.

color
required

Color for the AppointmentKind.

Available options:
SLATE,
RED,
POMEGRANATE,
ORANGE,
AMBER,
YELLOW,
LIME,
GREEN,
EMERALD,
TEAL,
CYAN,
SKY,
BLUE,
INDIGO,
VIOLET,
PURPLE,
FUCHSIA,
PINK,
WATERMELON,
ROSE
created
string<date-time>
required

The datetime this object was created.

description
string | null
required

Description of the appointment kind.

id
integer
required

The unique identifier for the appointment kind.

includes_pickup_and_dropoff
boolean
required

Whether appointments of this kind require a dropoff and pickup.

modified
string<date-time>
required

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

name
string
required

Display name for the appointment kind.