GET/transactional-api/appointment/get-metadata

Get Appointment Metadata

Returns the appointment services, appointment types and available procedures configured for the practice, for use when constructing a booking request (for example with Create Appointment Booking Link).

Authorization: Bearer token (JWT). See Authentication.

Responses

200 Appointment services configured for the practice.

{
  "appointmentServices": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "patientFacingName": "string",
      "appointmentTypes": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "patientFacingName": "string",
          "colour": "string",
          "availableProcedures": [
            {
              "conceptId": null,
              "description": null
            }
          ]
        }
      ]
    }
  ]
}