Get an appointment

Request

Returns a single appointment. visit_id links to the billing visit (it is null only on appointments created without a client). Re-read the appointment to obtain a fresh visit_id — visit grouping may change when the appointments of the day are edited. The response carries an ETag header for a subsequent PATCH.

Security

OAuth2(Required scopes: appointments:read) or RestrictedKey

Path

location_idintegerrequired

Identifier of the Location. Verified against the credential on every call — a Location the credential cannot access responds with 404.

appointment_idintegerrequired

Identifier of the appointment.

Query

expand[]Array of strings

Relations to embed, one level deep. Expanding client never bypasses PII rules — contact fields are null and listed in redacted_fields without clients:read_contact. Unknown values fail with 422.

Items Enum:"client""team_member"

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v3/openapi/locations/{location_id}/appointments/{appointment_id}?expand%5B%5D=client' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The appointment.

Headers

RateLimit-Remaininginteger, (int32), >= 0

Requests left in the most constrained policy window that applies to this request.

RateLimit-Resetinteger, (int32), >= 0

On 429, seconds until the most constrained policy frees up; it equals Retry-After there. On a successful response it reports the length of that policy's window rather than the time left in the current one, so treat it as the window size, not as a countdown — the counter to pace against is RateLimit-Remaining.

RateLimit-Policystring

Most constrained policy applied to the request, as <limit>;w=<window in seconds>.

Example:"10;w=60"

ETagstring

Version tag of the returned resource. Send it back in If-Match on the next PATCH or DELETE.

X-Request-Idstring

Request identifier for support and log correlation.

Bodyapplication/json

idintegerread-onlyrequired

objectstringread-onlyrequired

Value:"appointment"

location_idintegerread-onlyrequired

team_member_idintegerrequired

service_idsArray of integersrequired

statusstring(AppointmentStatus)required

Status of an appointment. waiting — scheduled, not yet confirmed; confirmed — confirmed by the client; arrived — the client attended (terminal "done" state); no_show — the client did not attend; cancelled — cancelled via the cancel command (never set through the status command).

Enum:"waiting""confirmed""arrived""no_show""cancelled"

starts_atstring, (date-time)required

RFC 3339 with the Location's local UTC offset.

duration_secondsintegerrequired

client_idinteger or null

null only on appointments without a client.

visit_idinteger or nullread-only

Billing visit of this appointment.

resource_instance_idsArray of integers

Resource instances occupied by the appointment.

ends_atstring, (date-time)read-only

RFC 3339 with the Location's local UTC offset.

is_paidbooleanread-only

Whether the visit of this appointment is fully paid.

commentstring or null

cancelled_atstring or null, (date-time)read-only

UTC; set by the cancel command.

cancellation_reasonstring or nullread-only

clientobject(Client)read-only

Present only when requested with expand[]=client; PII rules apply.

team_memberobject(TeamMember)read-only

Present only when requested with expand[]=team_member.

created_atstring, (date-time)read-only

UTC.

updated_atstring, (date-time)read-only

UTC.

Response

{
  "id": 12345,
  "object": "appointment",
  "location_id": 4321,
  "client_id": 789,
  "visit_id": 5001,
  "team_member_id": 321,
  "service_ids": [
    100
  ],
  "resource_instance_ids": [],
  "status": "waiting",
  "starts_at": "2026-07-24T11:30:00+01:00",
  "ends_at": "2026-07-24T12:30:00+01:00",
  "duration_seconds": 3600,
  "is_paid": false,
  "comment": null,
  "cancelled_at": null,
  "cancellation_reason": null,
  "created_at": "2026-07-20T09:57:15Z",
  "updated_at": "2026-07-20T09:57:15Z"
}