> ## 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 notification delivery history > Returns newest-first email and SMS delivery metadata attached to the referral or one of its visits. Recipient details, subjects, message bodies, email HTML, provider identifiers, and failure text are never returned. This capability is disabled until Scan enables notification read access for your account. ## OpenAPI ````yaml /openapi.yaml get /api/v2/referrals/{referral_id}/notifications openapi: 3.1.0 info: title: Scan.com API version: v2 description: > This API provides comprehensive access to Scan.com’s core functionalities, including management of referrals, patient information, authentication, body parts, and imaging modalities. It enables seamless integration for scheduling, data retrieval, and workflow automation within the Scan.com platform, facilitating efficient and secure handling of medical imaging processes. 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: >- Rank nearby imaging centers 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}/notifications: get: tags: - Referrals summary: Lists referral notification delivery history description: > Returns newest-first email and SMS delivery metadata attached to the referral or one of its visits. Recipient details, subjects, message bodies, email HTML, provider identifiers, and failure text are never returned. This capability is disabled until Scan enables notification read access for your account. operationId: listReferralNotifications parameters: - name: referral_id in: path required: true schema: type: string format: uuid - name: page in: query required: false schema: type: integer minimum: 1 default: 1 - name: per_page in: query required: false schema: type: integer minimum: 1 default: 20 responses: '200': description: Referral notification delivery metadata content: application/json: schema: type: object required: - referral_notifications - meta properties: referral_notifications: type: array items: $ref: '#/components/schemas/ReferralNotification' meta: type: object properties: current_page: type: integer next_page: type: integer nullable: true prev_page: type: integer nullable: true total_pages: type: integer total_count: type: integer '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' security: - BearerAuth: [] components: schemas: ReferralNotification: type: object description: Delivery metadata for an email or SMS associated with a referral required: - id - channel - notification_type - status - created_at - updated_at properties: id: type: string format: uuid channel: type: string enum: - email - sms notification_type: type: string nullable: true description: Stable template identifier for the communication example: hard_confirmation_to_patient status: type: string description: > Current delivery status. `pending` and `dispatched` are set by Scan; the rest come from the delivery provider, so the channels differ. Email reports `sent`, `delivered`, `opened`, `temporary_failure`, or `permanent_failure`. SMS reports `sent`, `delivered`, or `failed`. Ignore values you do not recognize. example: delivered created_at: type: string format: date-time updated_at: type: string format: date-time description: Last delivery-status update time visit_id: type: string format: uuid nullable: true description: Visit associated with the notification, when it is visit-specific 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 Forbidden: description: Endpoint is not enabled for this account headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: This endpoint is not enabled for your account message: This endpoint is not enabled for your account type: permission_error code: endpoint_not_enabled request_id: abc-123 documentation_url: https://docs.scan.com/guides/errors#endpoint_not_enabled 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 `. Sandbox tokens come from Get API keys and allow 2,000 successful requests or 7 days. Failed 4xx/5xx responses do not consume the allowance. Production tokens are issued from the group's API access tab. ````