---
title: "List referrals"
method: GET
path: "/referrals"
tags: ["referrals"]
---

# List referrals

`GET /referrals`

## Query parameters

- `_id` string
- `user` string
- `deleted` 0 | 1
- `createdBy` string
- `updatedBy` string
- `createdAt` string, date-time
- `updatedAt` string, date-time
- `page` integer
- `limit` integer
- `_populate` string
- `_select` string
- `facility` string
- `provider` string
- `patient` string
- `referringProviderId` string
- `referringProvider` string
- `duration` number
- `statusReason` 'patient-cancelled' | 'invalid-insurance' | 'missing-data' | 'other'
- `statusReasonDescription` string
- `source` 'upload' | 'patient-referral-form' | 'ui' | 'integrator' | 'followup' | 'manual'
- `status` 'active' | 'called' | 'called-late' | 'scheduled' | 'scheduled-late' | 'incomplete' | 'expired' | 'cancelled' | 'pending' | 'closed'
- `startOn` string, date-time
- `expireAt` string, date-time
- `attempt` number
- `lastAttemptSentAt` string, date-time
- `calledAt` string, date-time
- `acceptedAt` string, date-time
- `scheduledAt` string, date-time
- `notes` string
- `customerNotes` string
- `appointmentType` string
- `reason` string
- `departmentOrFacility` string
- `scheduledByAppointment` string
- `scheduledByOffer` string
- `processedReferralFollowup` 'pending' | 'skipped' | 'failed' | 'success'
- `upload` string
- `faxUpload` string
- `faxSentAt` string, date-time
- `scheduleStartOn` string, date-time
- `referringProviderFaxNumberOverride` string

## Response `200`

List of referrals

- object
  - `response` Referral[], required
    - `_id` string — Luma's internal ID of an object.
    - `user` string — The ID of the root account user.
    - `deleted` 0 | 1 — Flag for logical deletion where 1 means deleted.
    - `createdBy` string — The ID of the user who created this object.
    - `updatedBy` string — The ID of the user who updated this object.
    - `createdAt` string, date-time — The date/time when this object was created.
    - `updatedAt` string, date-time — The date/time when this object was updated.
    - `name` string
    - `facility` string
    - `provider` string
    - `patient` string
    - `referringProviderId` string
    - `referringProvider` string
    - `duration` number
    - `statusReason` 'patient-cancelled' | 'invalid-insurance' | 'missing-data' | 'other'
    - `statusReasonDescription` string
    - `source` 'upload' | 'patient-referral-form' | 'ui' | 'integrator' | 'followup' | 'manual'
    - `status` 'active' | 'called' | 'called-late' | 'scheduled' | 'scheduled-late' | 'incomplete' | 'expired' | 'cancelled' | 'pending' | 'closed'
    - `startOn` string, date-time
    - `expireAt` string, date-time
    - `attempt` number
    - `lastAttemptSentAt` string, date-time
    - `calledAt` string, date-time
    - `acceptedAt` string, date-time
    - `scheduledAt` string, date-time
    - `notes` string
    - `customerNotes` string
    - `appointmentType` string
    - `reason` string
    - `departmentOrFacility` string
    - `scheduledByAppointment` string
    - `scheduledByOffer` string
    - `processedReferralFollowup` 'pending' | 'skipped' | 'failed' | 'success'
    - `upload` string
    - `faxUpload` string
    - `faxSentAt` string, date-time
    - `scheduleStartOn` string, date-time
    - `referringProviderFaxNumberOverride` string
  - `page` integer, required
  - `size` integer, required

## Other responses

- `401` — Not authenticated
- `403` — Access token does not have the required scope

---

[API](https://skmtc.net/lumahealth/apis/rest-service.md) · [All operations](https://skmtc.net/lumahealth/apis/rest-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lumahealth/rest-service/revisions/d3c75c2a2f1d/schema)