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

# List reminders

`GET /reminders`

## Query parameters

- `provider` string
- `appointment` string
- `referral` string
- `recall` string
- `telehealth` string
- `followup` string
- `followupOperation` 'created' | 'deleted' | 'updated'
- `facility` string
- `patient` string
- `patientForm` string
- `message` string
- `type` 'appointment' | 'feedback' | 'referral' | 'outbound-referral' | 'followup' | 'patient-form' | 'recall' | 'telehealth' | 'waiting-room'
- `sendAt` string, date-time
- `sentAt` string, date-time
- `messageTemplate` string
- `status` 'scheduled' | 'pending' | 'queued' | 'sent' | 'confirmed' | 'emailOpened' | 'skipped' | 'delivered' | 'blocked'
- `statusReason` string
- `replied` integer
- `repliedMessage` string
- `originalRepliedMessage` string
- `repliedTime` string, date-time
- `forcedTime` boolean
- `createdBy` string
- `updatedBy` string
- `createdAt` string, date-time
- `updatedAt` string, date-time
- `page` integer
- `limit` integer
- `_populate` string
- `_select` string

## Response `200`

List of reminders

- object
  - `response` Reminder[], 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.
    - `provider` string
    - `appointment` string
    - `referral` string
    - `recall` string
    - `telehealth` string
    - `followup` string
    - `followupOperation` 'created' | 'deleted' | 'updated'
    - `facility` string
    - `patient` string
    - `patientForm` string
    - `message` string
    - `type` 'appointment' | 'feedback' | 'referral' | 'outbound-referral' | 'followup' | 'patient-form' | 'recall' | 'telehealth' | 'waiting-room'
    - `externalId` object
      - `source` 'mandrill' | 'twilio' | 'nexmo' | 'sendgrid' | 'plivo' | 'awsses'
      - `value` string
    - `sendAt` string, date-time
    - `sentAt` string, date-time
    - `contact` string[]
    - `messageTemplate` string
    - `status` 'scheduled' | 'pending' | 'queued' | 'sent' | 'confirmed' | 'emailOpened' | 'skipped' | 'delivered' | 'blocked'
    - `statusReason` string
    - `replied` integer
    - `repliedMessage` string
    - `originalRepliedMessage` string
    - `repliedTime` string, date-time
    - `paritalStatus` object[]
      - `status` 'scheduled' | 'pending' | 'queued' | 'sent' | 'confirmed' | 'emailOpened' | 'skipped' | 'delivered' | 'blocked'
      - `statusReason` string
      - `channel` 'sms' | 'email' | 'voice' | 'inapp' | 'chat' | 'fax' | 'whatsapp'
      - `message` string
    - `forcedTime` boolean
  - `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)