Appointment Types

The Appointment Types API provides access to the service types available for booking. Appointment types define duration, pricing, and booking policies.

Endpoints

Method	Endpoint	Description
`GET`	`/appointment-types`	List all appointment types
`GET`	`/appointment-types/{id}`	Retrieve an appointment type

Required scope: read_appointment_types

The Appointment Type Object

{
  "id": "type_123e4567-e89b-12d3-a456-426614174000",
  "name": "Initial Consultation",
  "description": "First visit with a clinician",
  "duration_minutes": 30,
  "price": 75.00,
  "currency": "GBP",
  "color": "#4CAF50",
  "is_active": true,
  "requires_payment": true,
  "allow_online_booking": true,
  "booking_notice_hours": 24,
  "cancellation_notice_hours": 48,
  "max_group_size": 1,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-06-15T10:00:00Z"
}

Attributes

Field	Type	Description
`id`	string	Unique identifier (UUID)
`name`	string	Display name
`description`	string	Description of the service
`duration_minutes`	integer	Appointment length in minutes
`price`	number	Price for the service
`currency`	string	Currency code (GBP, USD, etc.)
`color`	string	Display color (hex)
`is_active`	boolean	Whether type is available
`requires_payment`	boolean	Payment required at booking
`allow_online_booking`	boolean	Available for online booking
`booking_notice_hours`	integer	Minimum hours before appointment
`cancellation_notice_hours`	integer	Minimum hours for free cancellation
`max_group_size`	integer	Maximum attendees (1 = individual)
`created_at`	string	ISO 8601 creation timestamp
`updated_at`	string	ISO 8601 last update timestamp

List Appointment Types

GET /appointment-types

Query Parameters

Parameter	Type	Default	Description
`limit`	integer	100	Number of records (max 100)
`offset`	integer	0	Pagination offset

Request

curl -X GET "https://app.usejump.co.uk/functions/v1/api-v1/appointment-types" \
  -H "Authorization: Bearer pk_live_your_api_key"

Response

{
  "data": [
    {
      "id": "type_123e4567-e89b-12d3-a456-426614174000",
      "name": "Initial Consultation",
      "duration_minutes": 30,
      "price": 75.00,
      "currency": "GBP",
      "is_active": true,
      "allow_online_booking": true
    },
    {
      "id": "type_234f5678-e89b-12d3-a456-426614174111",
      "name": "Follow-up Appointment",
      "duration_minutes": 15,
      "price": 45.00,
      "currency": "GBP",
      "is_active": true,
      "allow_online_booking": true
    }
  ],
  "pagination": {
    "total": 2,
    "limit": 100,
    "offset": 0,
    "has_more": false
  }
}

Retrieve an Appointment Type

GET /appointment-types/{id}

Request

curl -X GET "https://app.usejump.co.uk/functions/v1/api-v1/appointment-types/type_123e4567" \
  -H "Authorization: Bearer pk_live_your_api_key"

Response

{
  "data": {
    "id": "type_123e4567-e89b-12d3-a456-426614174000",
    "name": "Initial Consultation",
    "description": "First visit with a clinician",
    "duration_minutes": 30,
    "price": 75.00,
    "currency": "GBP",
    "color": "#4CAF50",
    "is_active": true,
    "requires_payment": true,
    "allow_online_booking": true,
    "booking_notice_hours": 24,
    "cancellation_notice_hours": 48,
    "max_group_size": 1,
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-06-15T10:00:00Z"
  }
}

Related Resources

Availability - Check available slots
Holds - Reserve appointment slots
Appointments - Book appointments
Clinicians - View clinicians

Prescriptions Clinicians