# List appointment summaries for referrers and specialists

Returns appointment summaries 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 optional filters via query string and offset paging via skip and take.

Response body is a JSON array. Fields below apply to each array item.

Endpoint: GET /integrations/v1/{domain}/appointments/referrer
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 (ISO 8601 date, yyyy-MM-dd) in the scheduled site's local timezone.
    Example: "2025-01-01"

  - `startDate` (string)

  - `endDate` (string)

  - `clientUtcOffsetMinutes` (integer)

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

  - `skip` (integer)
    Optional number of items to skip. Defaults to 0 when omitted. Must be between 0 and 10000.

  - `take` (integer)
    Optional maximum number of items to return. Defaults to 100 when omitted. Must be between 1 and 500.
    Example: 100

## Header parameters:

  - `X-Correlation-Id` (string)
    Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.
    Example: "4b7f0a91b4f54f2a"

## 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` (null,string)
    Appointment date (ISO 8601, yyyy-MM-dd) in the scheduled site's local timezone.
    Example: "2020-01-01"

  - `startTime` (null,string)
    Scheduled start time (ISO 8601, HH:mm:ss) in the scheduled site's local timezone.
    Example: "13:45:00"

  - `endTime` (null,string)
    Scheduled end time (ISO 8601, HH:mm:ss) in the scheduled site's local timezone.
    Example: "13:45:00"

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

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

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

  - `type` (string)
    Stable error type identifier (urn:qubs:integrations:...). For each response, the type matches the HTTP status.
    Enum: "urn:qubs:integrations:bad-request"

  - `title` (null,string)
    Short, human-readable summary of the error.
    Example: "Example title"

  - `status` (integer)
    HTTP status code for this error response.
    Example: 400

  - `detail` (null,string)
    Detailed description of the error.
    Example: "Example detail"

  - `instance` (null,string)
    Request path for this error.
    Example: "Example instance"

  - `requestId` (string)
    Request correlation identifier for support. Also returned as the X-Correlation-Id response header.
    Example: "4b7f0a91b4f54f2a"

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

  - `type` (string)
    Stable error type identifier (urn:qubs:integrations:...). For each response, the type matches the HTTP status.
    Enum: "urn:qubs:integrations:unauthorized"

  - `title` (null,string)
    Short, human-readable summary of the error.
    Example: "Example title"

  - `status` (integer)
    HTTP status code for this error response.
    Example: 401

  - `detail` (null,string)
    Detailed description of the error.
    Example: "Example detail"

  - `instance` (null,string)
    Request path for this error.
    Example: "Example instance"

  - `requestId` (string)
    Request correlation identifier for support. Also returned as the X-Correlation-Id response header.
    Example: "4b7f0a91b4f54f2a"

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

  - `type` (string)
    Stable error type identifier (urn:qubs:integrations:...). For each response, the type matches the HTTP status.
    Enum: "urn:qubs:integrations:forbidden"

  - `title` (null,string)
    Short, human-readable summary of the error.
    Example: "Example title"

  - `status` (integer)
    HTTP status code for this error response.
    Example: 403

  - `detail` (null,string)
    Detailed description of the error.
    Example: "Example detail"

  - `instance` (null,string)
    Request path for this error.
    Example: "Example instance"

  - `requestId` (string)
    Request correlation identifier for support. Also returned as the X-Correlation-Id response header.
    Example: "4b7f0a91b4f54f2a"

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

  - `type` (string)
    Stable error type identifier (urn:qubs:integrations:...). For each response, the type matches the HTTP status.
    Enum: "urn:qubs:integrations:too-many-requests"

  - `title` (null,string)
    Short, human-readable summary of the error.
    Example: "Example title"

  - `status` (integer)
    HTTP status code for this error response.
    Example: 429

  - `detail` (null,string)
    Detailed description of the error.
    Example: "Example detail"

  - `instance` (null,string)
    Request path for this error.
    Example: "Example instance"

  - `requestId` (string)
    Request correlation identifier for support. Also returned as the X-Correlation-Id response header.
    Example: "4b7f0a91b4f54f2a"

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

  - `type` (string)
    Stable error type identifier (urn:qubs:integrations:...). For each response, the type matches the HTTP status.
    Enum: "urn:qubs:integrations:server-error"

  - `title` (null,string)
    Short, human-readable summary of the error.
    Example: "Example title"

  - `status` (integer)
    HTTP status code for this error response.
    Example: 500

  - `detail` (null,string)
    Detailed description of the error.
    Example: "Example detail"

  - `instance` (null,string)
    Request path for this error.
    Example: "Example instance"

  - `requestId` (string)
    Request correlation identifier for support. Also returned as the X-Correlation-Id response header.
    Example: "4b7f0a91b4f54f2a"