> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lists referral activities

> Returns the referral activity feed, newest first. A `rescheduled` row is
recorded when a booked visit is given a new time or location. `created_at`
is when that reschedule happened, and `late` is true when it was within
24 hours of the appointment. The visit status stays `booked`.




## OpenAPI

````yaml /openapi.yaml get /api/v2/referrals/{referral_id}/activities
openapi: 3.1.0
info:
  title: Scan.com API
  version: v2
  description: >-
    The Scan.com Partner API creates imaging referrals, schedules visits, and
    returns radiology reports.
servers:
  - url: https://api.staging.scan.com
    description: Sandbox
  - url: https://api.scan.com
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Courier SSO
    description: >-
      Mint a one-time Courier portal SSO URL with the same Bearer token used for
      the rest of the API.
  - name: Webhooks
    description: >-
      Outbound HTTP POST notifications sent to your api_credentials.webhook_url
      when visit or notification status changes. Configure api_credentials on
      your LawFirm, Practice, CoordinationGroup, Insurance, Employer, or
      NurseCaseManagementGroup.
  - name: Order Documents
    description: >-
      Retrieve radiology report PDFs, DICOM imaging, and invoices for orders
      visible to the authenticated group.
  - name: Locations
    description: >-
      Search imaging centers near an address, or rank them for a referral after
      medical safety answers are on file. Partners submit a preferred center;
      Scan books the visit.
  - name: Testing
    description: Staging-only fixture bootstrap, status advancement, and test webhooks.
  - name: FHIR
    description: >-
      Opt-in FHIR R4 read shapes for DiagnosticReport and ImagingStudy. Not a
      FHIR server.
paths:
  /api/v2/referrals/{referral_id}/activities:
    get:
      tags:
        - Referrals
      summary: Lists referral activities
      description: >
        Returns the referral activity feed, newest first. A `rescheduled` row is

        recorded when a booked visit is given a new time or location.
        `created_at`

        is when that reschedule happened, and `late` is true when it was within

        24 hours of the appointment. The visit status stays `booked`.
      operationId: listReferralActivities
      parameters:
        - name: referral_id
          in: path
          required: true
          description: Referral ID
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Referral activities
          content:
            application/json:
              schema:
                type: object
                required:
                  - activities
                properties:
                  activities:
                    type: array
                    items:
                      $ref: '#/components/schemas/ReferralActivity'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  schemas:
    ReferralActivity:
      type: object
      description: One row from the referral activity feed
      required:
        - type
        - created_at
        - appointment_id
      properties:
        type:
          type: string
          description: >
            `order_received`, `call_log`, `scheduled_appointment`,
            `ready_to_book`,

            `images_received`, `reports_ready`, `critical_update`, `canceled`,

            `new_scans_added`, or `rescheduled`.
          example: rescheduled
        created_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            When the activity happened. For `rescheduled`, this is when the
            visit was rescheduled.
        visit_id:
          type: string
          format: uuid
          nullable: true
        appointment_id:
          type: string
          format: uuid
        description:
          type: string
          nullable: true
        incident_date:
          type: string
          nullable: true
        call_type:
          type: string
          nullable: true
          description: Present on `call_log` rows
        user:
          type: string
          nullable: true
          description: Present on `call_log` rows
        late:
          type: boolean
          description: >-
            Present on `rescheduled` rows. True when the appointment was moved
            within 24 hours of its start time.
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        type:
          type: string
          example: validation_error
        code:
          type: string
          example: unprocessable_entity
        request_id:
          type: string
        documentation_url:
          type: string
        errors:
          type: array
          items:
            type: string
      required:
        - error
        - message
        - type
        - code
  responses:
    Unauthorized:
      description: Missing, expired, or wrong-environment token
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              value:
                error: Unauthorized
                message: Unauthorized
                type: authentication_error
                code: unauthorized
                request_id: abc-123
                documentation_url: https://docs.scan.com/guides/errors#unauthorized
            expired:
              value:
                error: API token expired
                message: API token expired
                type: authentication_error
                code: api_token_expired
                request_id: abc-123
                documentation_url: https://docs.scan.com/guides/errors#api_token_expired
    NotFound:
      description: Resource not found or not accessible to this account
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Referral not found
            message: Referral not found
            type: not_found_error
            code: not_found
            request_id: abc-123
            documentation_url: https://docs.scan.com/guides/errors#not_found
    TooManyRequests:
      description: Sandbox request allowance exhausted
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Sandbox request limit reached
            message: Sandbox request limit reached
            type: rate_limit_error
            code: sandbox_request_limit_reached
            request_id: abc-123
            documentation_url: https://docs.scan.com/guides/errors#sandbox_request_limit_reached
    InternalServerError:
      description: Unexpected internal error
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Internal server error
            message: Internal server error
            type: api_error
            code: internal_error
            request_id: abc-123
            documentation_url: https://docs.scan.com/guides/errors#internal_error
  headers:
    RequestId:
      description: Correlate this response with Scan support.
      schema:
        type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        `Authorization: Bearer <api_token>`. Reuse the same token on later
        requests

        until it expires or is revoked. Do not request a new token for each
        call.

        The token does not expire after 24 hours. Sandbox tokens come from Get

        API keys and allow 2,000 successful requests or 7 days, or 90 days with

        an access code. Failed 4xx/5xx responses do not consume the allowance.

        Production tokens are issued from the group's API access tab and last

        until the expiry set there, or until revoked when no expiry is set.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.