Get appointment type by ID

Request

Retrieve details for a specific appointment type.

Security

PartnerApiKey and PartnerOAuth

Path

appointmentTypeIdinteger, (int64)required

Appointment Type ID

accountIdinteger, (int64)required

Account identifier

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/appointment/type/{appointmentTypeId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Appointment type found and returned successfully

Bodyapplication/json

activeboolean

Indicates if the type is active

Example:true

colorstring

Display color code (hex)

Example:"#2B46FF"

createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"

descriptionstring

Description/Instructions for the appointment

Example:"Please arrive 15 minutes early to fill out paperwork."

durationinteger, (int32)

Duration in minutes

Example:30

idinteger, (int64)

Unique identifier

Example:1001

namestring

Name of the appointment type

Example:"New Patient Consultation"

telehealthinteger, (int32)

Telehealth configuration (0=none, 1=with forms, 2=no forms)

Example:1

Response

{
  "active": true,
  "color": "#2B46FF",
  "createdAt": "2025-01-15T14:00:00Z",
  "description": "Please arrive 15 minutes early to fill out paperwork.",
  "duration": 30,
  "id": 1001,
  "name": "New Patient Consultation",
  "telehealth": 1
}