# List operational appointments by status

Returns the operational appointment view filtered by status when the caller is authorized. Supports cursor-based pagination via pageSize and nextToken.

Endpoint: GET /integrations/v1/{domain}/appointments/operational/by-status/{status}
Version: v1
Security: Bearer

## Path parameters:

  - `domain` (string, required)
    Partner domain identifier. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.
    Example: "acme"

  - `status` (string, required)
    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", "TYPING INPROGRESS", "PENDING REPORTING", "STUDY INPROGRESS", "SECOND REVIEW", "FINALISED", "REVIEW TYPED", "PEER REVIEW", "SECOND OPINION"

## Query parameters:

  - `pageSize` (integer,string)
    Maximum number of items to return in a page. Defaults to 100 when omitted.
    Example: 100

  - `nextToken` (string)
    Opaque continuation token from a previous paged response. Omit for the first page.
    Example: "eyJwYWdlIjoyfQ=="

## Response 200 fields (application/json):

  - `items` (array, required)
    Operational appointments in the current page.

  - `items.domain` (string, required)
    Domain this appointment belongs to.
    Example: "Example domain"

  - `items.appointmentId` (string, required)
    Appointment identifier.
    Example: "123"

  - `items.scheduledSite` (string, required)
    Scheduled site name.
    Example: "Example scheduledSite"

  - `items.status` (string, required)
    Appointment status.
    Enum: "NOT ARRIVED", "ARRIVED", "DID NOT ATTEND", "APPPOINTMENT CANCELLED", "CANCELLATION LIST", "DICTATION INPROGRESS", "DICTATED", "TYPED", "AUTHORISING", "AUTHORISED", "TYPING INPROGRESS", "PENDING REPORTING", "STUDY INPROGRESS", "SECOND REVIEW", "FINALISED", "REVIEW TYPED", "PEER REVIEW", "SECOND OPINION"

  - `items.appointmentDate` (string)
    Appointment date string as stored in QUBS.
    Example: "Example appointmentDate"

  - `items.startTime` (string)
    Scheduled start time string as stored in QUBS.
    Example: "Example startTime"

  - `items.endTime` (string)
    Scheduled end time string as stored in QUBS.
    Example: "Example endTime"

  - `items.modality` (string)
    Example: "Example modality"

  - `items.studyDescription` (string)
    Example: "Example description"

  - `items.room` (string)
    Example: "Example room"

  - `items.priority` (string)
    Example: "Example priority"

  - `items.billingStatus` (string)
    Example: "active"

  - `items.billingType` (string)
    Example: "Example billingType"

  - `items.arrivalDateTime` (null,string)
    Example: "2020-01-01T00:00:00Z"

  - `items.scanStartDateTime` (null,string)
    Example: "2020-01-01T00:00:00Z"

  - `items.scanEndDateTime` (null,string)
    Example: "2020-01-01T00:00:00Z"

  - `items.scanTotalTime` (null,number,string)
    Example: 1.23

  - `items.waitingTotalTime` (null,number,string)
    Example: 1.23

  - `items.examCodes` (array)
    Exam codes attached to the appointment.

  - `items.examCodes.examCodeId` (string, required)
    Unique exam code identifier.
    Example: "123"

  - `items.examCodes.key` (string, required)
    QUBS internal key for the exam code record.
    Example: "Example key"

  - `items.examCodes.site` (string, required)
    Site this exam code belongs to.
    Example: "Example site"

  - `items.examCodes.description` (string, required)
    Human-readable exam description.
    Example: "Example description"

  - `items.examCodes.domain` (string)
    Example: "Example domain"

  - `items.examCodes.category` (string)
    Example: "Example category"

  - `items.examCodes.colour` (string)
    Example: "Example colour"

  - `items.examCodes.totalDuration` (integer,string)
    Configured duration in minutes.
    Example: 1

  - `items.examCodes.showOnline` (boolean)
    Whether this exam is visible/available online.
    Example: true

  - `items.examCodes.lastModifiedDateTime` (null,string)
    Example: "2020-01-01T00:00:00Z"

  - `items.examCodes.extraInfo` (null,string)
    Example: "Example extraInfo"

  - `items.examCodes.onlineInfo` (null,string)
    Example: "Example onlineInfo"

  - `items.examCodes.preparations1` (null,string)
    Example: "Example preparations1"

  - `items.examCodes.order` (integer,string)
    Example: 1

  - `items.examCodes.worksheetId` (null,string)
    Example: "123"

  - `nextToken` (null,string)
    Opaque continuation token to fetch the next page, when more results are available.
    Example: "Example nextToken"

## Response 400 fields (application/problem+json):

  - `type` (null,string)
    Example: "Example type"

  - `title` (null,string)
    Example: "Example title"

  - `status` (null,integer,string)
    Example: 1

  - `detail` (null,string)
    Example: "Example detail"

  - `instance` (null,string)
    Example: "Example instance"

## Response 401 fields (application/problem+json):

  - `type` (null,string)
    Example: "Example type"

  - `title` (null,string)
    Example: "Example title"

  - `status` (null,integer,string)
    Example: 1

  - `detail` (null,string)
    Example: "Example detail"

  - `instance` (null,string)
    Example: "Example instance"

## Response 403 fields (application/problem+json):

  - `type` (null,string)
    Example: "Example type"

  - `title` (null,string)
    Example: "Example title"

  - `status` (null,integer,string)
    Example: 1

  - `detail` (null,string)
    Example: "Example detail"

  - `instance` (null,string)
    Example: "Example instance"

## Response 500 fields (application/problem+json):

  - `type` (null,string)
    Example: "Example type"

  - `title` (null,string)
    Example: "Example title"

  - `status` (null,integer,string)
    Example: 1

  - `detail` (null,string)
    Example: "Example detail"

  - `instance` (null,string)
    Example: "Example instance"