---
title: "Show a list of recalls"
method: GET
path: "/recalls"
tags: ["recalls"]
---

# Show a list of recalls

`GET /recalls`

## Request

- Base URL: `https://api.lumahealth.io/api/v2`
- URL: `https://api.lumahealth.io/api/v2/recalls`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/lumahealth/apis/rest-service/docs/recalls/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `patient` string
- `provider` string
- `facility` string
- `appointment` string
- `appointmentType` string
- `date` unknown
- `source` 'active' | 'pending' | 'scheduled'
- `status` 'active' | 'pending' | 'scheduled'
- `attempt` string
- `q` 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

## Response `200`

Returns a list of recalls

- object
  - `response` RecallResponse[], required
    - `_id` string, required: 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.
    - `patient` string: patient
    - `provider` string: provider
    - `facility` string: facility
    - `appointment` string: appointment
    - `type` string: appointmentType
    - `date` string: date
    - `source` 'upload' | 'ui' | 'integrator': source
    - `status` 'active' | 'pending' | 'scheduled': status
    - `attempt` string: attempt
  - `page` integer, required
  - `size` integer, required

## Other responses

- `401`: Not authenticated
- `403`: Access token does not have the required scope
- `default`: unexpected error

---

[API](https://skmtc.dev/lumahealth/apis/rest-service.md) - [All operations](https://skmtc.dev/lumahealth/apis/rest-service/llms.txt) - [OpenAPI document](https://skmtc.dev/lumahealth/apis/rest-service/revisions/f19aeba84a26?raw)