Skip to main content
GET
List reminder categories

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.
  • name: Filter by the category's name.
  • mandatory: eq(mandatory,true) lists only the mandatory categories.
  • archived: eq(archived,true) lists only archived categories, and eq(archived,false) only live ones. Both are listed when it is not given.

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.

Available options:
name,
-name,
created_at,
-created_at

Response

A list of reminder categories

JSON API response object

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