Skip to main content
GET
List reminder pauses

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.
  • user: Filter by the paused person, e.g. eq(user,X).
  • starts_on: Filter by the first paused date, as an RFC 3339 time at midnight UTC, e.g. le(starts_on,2026-12-31T00:00:00Z).
  • ends_on: Filter by the last paused date, as an RFC 3339 time at midnight UTC, e.g. ge(ends_on,2026-11-17T00:00:00Z) for pauses that have not ended.

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 starts_on.

Available options:
starts_on,
-starts_on,
ends_on,
-ends_on,
created_at,
-created_at

Response

A list of reminder pauses

JSON API response object

data
A list of reminder pauses · object[]
required
meta
object
required
jsonapi
object
required