Skip to main content
GET
List reminders

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

org_id
string<uuid>
required

The unique identifier for the organisation.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
page
object

JSON:API pagination, as page[limit] and page[offset]. The same as the top-level limit and offset parameters; when both forms are sent, page[...] wins.

filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • organisation: The organisation in the path, as eq(organisation,X). Rows always come from that organisation; the term is accepted so a client can name it.
  • category: Filter by the reminder's category, e.g. in(category,[X,Y]).
  • status: Filter by the reminder's status: active or lapsed.
  • mandatory: Filter by whether the reminder's category is mandatory. and(eq(status,lapsed),eq(mandatory,true)) lists the organisation's lapsed mandatory reminders, and its meta.pagination counts them.
  • owner: Filter by the user who owns the reminder.
  • expires_at: Filter by the expiry date, e.g. and(ge(expires_at,2026-12-01T00:00:00Z),le(expires_at,2026-12-31T23:59:59Z)).

For more information on using named filters, see the docs

sort
enum<string>[]

A comma separated list of fields to sort by. A - prefix sorts descending. Any other field is refused. The default is expires_at.

Available options:
expires_at,
-expires_at,
title,
-title,
created_at,
-created_at

Response

A list of reminders

JSON API response object

data
A list of reminders · object[]
required
meta
object
required
jsonapi
object
required