---
title: "List reminders"
method: POST
path: "/reminder/list/"
tags: ["Reminders"]
---

# List reminders

`POST /reminder/list/`

## Request

- Base URL: `https://wbiztool.com/api/v1`
- URL: `https://wbiztool.com/api/v1/reminder/list/`
- Auth: none required

Active and paused reminders of the workspace, 50 per page, newest first (cancelled ones excluded). POST only. `next_run` is computed as if the timezone were UTC, and the timezone is not returned.

## Request body

- ListRemindersRequest: Your API credentials, sent in the request body (JSON or form fields) of every request that uses them. Both come from Settings → API keys in the dashboard. The API key decides which workspace the request acts on.
  - `client_id` integer, required: Your API Client ID from Settings → API keys.
  - `api_key` string, required: One of your API keys from the same page. Keep it secret.
  - `page` integer: 50 per page.

## Response `200`

One page of reminders.

- ReminderList
  - `status` 1, required
  - `message` 'Success', required
  - `reminders` Reminder[], required
    - `id` integer
    - `name` string: The reminder name, or `Unnamed Reminder`.
    - `to_number` string: Phone number or group name the reminder is sent to.
    - `message_template` string
    - `msg_type` 0 | 1 | 2: `0` text (default), `1` image, `2` file or document.
    - `msg_type_display` 'Text' | 'Image' | 'File'
    - `img_url` string, nullable
    - `file_name` string, nullable
    - `cron_expression` string
    - `next_run` string: Next match as `YYYY-MM-DD HH:MM:SS UTC`, computed as if the reminder's timezone were UTC, or `Invalid cron`.
    - `is_active` boolean: `false` when paused.
    - `whatsapp_client_id` integer, nullable
    - `created_at` string: UTC, `YYYY-MM-DD HH:MM:SS`.
  - `total` integer, required
  - `page` integer, required
  - `page_size` 50, required

## Other responses

- `400`: Refused: `Invalid JSON format: …` (also for GET), `Auth Error - Please send correct API key and Client id`, `Invalid client id`, `Auth Error: invalid api key`, `Auth Error: please check client id`, `Demo Account cannot access APIs`, `Upgrade your plan to use reminders feature`.
- `500`: `Error fetching reminders: …`

---

[API](https://skmtc.dev/wbiztool/apis/wbiztool-api.md) · [All operations](https://skmtc.dev/wbiztool/apis/wbiztool-api/llms.txt) · [OpenAPI document](https://skmtc.dev/wbiztool/apis/wbiztool-api/revisions/bc7380bb5684?raw)