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

# List reminders

`GET /v1/reminders`

Retrieve a list of reminders in the workspace.

## Query parameters

- `limit` integer
- `cursor` string
- `entity.id` string

## Response `200`

A paginated list of reminders in the workspace.

- object
  - `data` object, required
    - `items` Reminder[], required
      - `id` string, required
      - `name` string, required
      - `entity` object, required
        - `id` string, required — The ID of the entity connected to the reminder.
        - `entityType` 'person' | 'company' | 'object', required — The type of the entity connected to the reminder. Can be `person`, `company` or `object`.
        - `fullName` string, required — The full name of the entity connected to the reminder.
      - `recurrenceRule` string, required — The recurrence rule of the reminder. The recurrence rule is a string that follows the iCalendar format specified in [RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-8-5-3-recurrence-rule.html).
      - `visibility` 'public' | 'private', required — The visibility of the reminder. - `public`: The reminder is visible to all users in the workspace. - `private`: The reminder is visible only to the current user.
      - `assignedUsers` User[], required — A list of workspace users to be notified when the reminder is triggered. For private reminders, only the current user is notified.
        - `id` string, required
        - `fullName` string, required
        - `email` string, required
      - `nextTriggerTime` string, date-time, nullable, required — The next trigger time of the reminder.
      - `lastTriggerTime` string, date-time, nullable, required — The last trigger time of the reminder.
      - `createdBy` object, required — The user who created the reminder.
        - `id` string, required
        - `fullName` string, required
        - `email` string, required
      - `createdAt` string, nullable, required — The date and time the reminder was created, in ISO format.
    - `pagination` object, required
      - `nextLink` string
  - `deprecations` string[]

## Other responses

- `400` — The request was unacceptable, often due to missing an invalid parameter.
- `401` — No valid API key provided.
- `403` — The API key doesn’t have permissions to perform the request.
- `404` — The requested resource doesn’t exist.
- `422` — The request was unacceptable, often due to missing or invalid parameters.
- `429` — Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
- `500` — Something went wrong on our end.
- `503` — The server is overloaded or down for maintenance.

---

[API](https://skmtc.dev/folk/apis/folk-external-api.md) · [All operations](https://skmtc.dev/folk/apis/folk-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/folk/folk-external-api/revisions/8ecbf0ccd00a/schema)