# List operational appointments for a domain

Returns the operational appointment view for the specified domain when the caller is authorized. Supports optional filters via query string and offset paging via skip and take.

Endpoint: GET /integrations/v1/{domain}/appointments/operational
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"

## Query parameters:

  - `appointmentDate` (string)
    Optional appointment date filter. Format is integration-specific and typically matches the QUBS date string for the domain.
    Example: "01-01-2025"

  - `scheduledSite` (string)
    Optional scheduled site filter.
    Example: "Example Site"

  - `skip` (integer,string)
    Optional number of items to skip. Defaults to 0 when omitted.

  - `take` (integer,string)
    Optional maximum number of items to return. Defaults to 100 when omitted.
    Example: 100

## Response 200 fields (application/json):

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

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

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

  - `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"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

## 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"