List operational appointments by status for referrers and specialists

Request

Returns operational appointments filtered by provider number when the caller is authorized and scoped to referrer/specialist grants. Provider numbers are resolved from the authenticated principal's access grants and are not supplied as query parameters. Supports cursor-based pagination via pageSize and nextToken.

Security

Bearer

Path

domainstringrequired

Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.

Example:acme

statusstringrequired

Appointment status filter value. Must match one of the known QUBS appointment status strings.

Enum:"NOT ARRIVED""ARRIVED""DID NOT ATTEND""APPPOINTMENT CANCELLED""CANCELLATION LIST""DICTATION INPROGRESS""DICTATED""TYPED""AUTHORISING""AUTHORISED"

Example:NOT ARRIVED

Query

pageSizeinteger, (int32), [ 1 .. 500 ]

Maximum number of items to return in a page. Defaults to 100 when omitted. Must be between 1 and 500.

Default:100

Example:pageSize=100

nextTokenstring

Opaque, URL-safe continuation token returned as nextToken in a previous paged response. Omit for the first page.

Example:nextToken=DDB_NEXT_TOKEN

X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:4b7f0a91b4f54f2a

curl -i -X GET \
  'https://partnerdocs.qubs.io/_mock/openapi/integrations/v1/acme/appointments/referrer/operational/by-status/NOT ARRIVED?pageSize=100&nextToken=DDB_NEXT_TOKEN' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-Id: 4b7f0a91b4f54f2a'

Responses

OK

Headers

X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:"4b7f0a91b4f54f2a"

Bodyapplication/json

itemsArray of objects(AppointmentOperationalResponse)required

Operational appointments in the current page.

nextTokennull or string

Opaque continuation token to fetch the next page, when more results are available.

Example:"Example nextToken"

Response

{
  "items": [
    { … }
  ],
  "nextToken": "DDB_NEXT_TOKEN"
}