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.

Response fields

Field	Type	Description
`appointmentServices[].id`	`string<uuid>`
`appointmentServices[].name`	`string`
`appointmentServices[].patientFacingName`	`string` (nullable)
`appointmentServices[].appointmentTypes[].id`	`string<uuid>`
`appointmentServices[].appointmentTypes[].name`	`string`
`appointmentServices[].appointmentTypes[].patientFacingName`	`string` (nullable)
`appointmentServices[].appointmentTypes[].colour`	`string` (nullable)
`appointmentServices[].appointmentTypes[].availableProcedures[].conceptId`	`string`
`appointmentServices[].appointmentTypes[].availableProcedures[].description`	`string` (nullable)

{
  "appointmentServices": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Standard GP Consultation",
      "patientFacingName": "GP Appointment",
      "appointmentTypes": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "Follow-up Consultation",
          "patientFacingName": "Follow-up Appointment",
          "colour": "#4A90D9",
          "availableProcedures": [
            {
              "conceptId": null,
              "description": null
            }
          ]
        }
      ]
    }
  ]
}

Responses​

Responses