GET/api/v1/s2s/appointments/{appointmentId}
Get partner appointment
Published Partner endpoint from the stable OpenAPI 1.0.0 contract.
Overview
Use this endpoint only with a Partner API key. Code samples use placeholders and the public sandbox URL.
- Method
- GET
- Endpoint
- /api/v1/s2s/appointments/{appointmentId}
- Authentication
- X-API-Key
Request
Parameters
- appointmentIdstring (uuid)pathRequired
- Tenant-local appointment reference: either the Booking id (UUID) or the video call id (sessionRef) delivered in the appointment payload.
- Example: 8cb6d8b8-a582-4cd2-8095-f60537a0d3dc
- X-Correlation-IDstringheader
- Optional opaque request correlation ID for tracing API calls across systems. Billing audit paths persist only UUIDv4-shaped values and drop free-form values.
- Example: 33333333-3333-4333-8333-333333333333
Contract
The versioned OpenAPI contract is the authoritative source for parameters, request bodies, and response schemas.
Version
1.0.0
Expected response
200 OK