v1

latestOpenAPI 3.1.02026-07-223614164.6 KB
Reminders

List reminders

Retrieve a list of reminders in the workspace.

get/v1/reminders

Query parameters

limitinteger

The number of items to return.

cursorstring

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

entity.idstring

Filter reminders by entity. Only reminders linked to the specified entity will be returned.

Response

A paginated list of reminders in the workspace.

deprecationsstring[]

Example response

{
  "data": {
    "items": [
      {
        "id": "rmd_91118b73-5a75-480b-b8e3-a33671c35cdc",
        "name": "Reminder on John Doe",
        "entity": {
          "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
          "entityType": "person",
          "fullName": "John Doe"
        },
        "recurrenceRule": "DTSTART;TZID=Europe/Paris:20250717T090000\nRRULE:FREQ=WEEKLY;INTERVAL=1",
        "visibility": "public",
        "assignedUsers": [
          {
            "id": "usr_a45c30d8-19fc-4939-94c7-17dc5e46f476",
            "fullName": "John Doe",
            "email": "john.doe@example.com"
          }
        ],
        "nextTriggerTime": "2025-07-17T09:00:00.000Z",
        "lastTriggerTime": "2025-05-17T09:00:00.000Z",
        "createdBy": {
          "id": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
          "fullName": "John Doe",
          "email": "john.doe@example.com"
        },
        "createdAt": "2021-01-01T00:00:00.000Z"
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/reminders?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}