Skip to main content
GET
List form reminder occurrences

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.
  • form: Filter by the form, e.g. eq(form,X).
  • reminder: Filter by the reminder, e.g. eq(reminder,X).
  • user: Filter by the person, e.g. eq(user,X).
  • state: Filter by state, e.g. in(state,[due,missed]) for what is still to fill in.
  • due_at: Filter by when it fell due, as an RFC 3339 time, e.g. ge(due_at,2026-11-01T00:00:00Z).
  • grace_ends_at: Filter by when its grace period ends, as an RFC 3339 time.
  • local_date: Filter by the date it fell on in the person's timezone, as an RFC 3339 time at midnight UTC, e.g. eq(local_date,2026-11-17T00:00:00Z).
  • id: Filter by the occurrence's id, e.g. in(id,[X,Y]).
  • submission: Filter by the submission that closed it, e.g. eq(submission,X).

For more information on using named filters, see the docs

sort
enum<string>[]

The list is sorted latest due first, -due_at, which is the default and the only sort offered.

Available options:
-due_at

Response

A list of form reminder occurrences

JSON API response object

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