GET
/api/public/v1/appointments/{appointmentId}

Get an appointment

Retrieve a single appointment by ID.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

appointments:read

Path Parameters

NameTypeRequiredDescription
appointmentIdstringRequiredAppointment ID.
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/appointments/{appointmentId}" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Appointment retrieved successfully!",
  "content": {
    "appointment": {
      "id": "appt_1",
      "status": "CONFIRMED"
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Scheduling → Appointments
/scheduling/list
  1. Open an appointment from the table.