Skip to main content
GET
List calendar entries

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:""

Chooses the entries to list. ge(date,...) and le(date,...) are required, and the range they give may be at most 93 days long.

Available filters:

  • date: The range of dates, as and(ge(date,2026-12-01T00:00:00Z),le(date,2026-12-31T23:59:59Z)).
  • source: Only these sources: reminders, documents, competencies or work-permits, e.g. in(source,[reminders,documents]).
  • category: Only reminders in these categories, e.g. in(category,[X]). Entries from other sources are left out when it is given.

Any other term, or an or(), is refused.

For more information on using named filters, see the docs

Response

A list of calendar entries

JSON API response object

data
A list of calendar entries · object[]
required
meta
object
required
jsonapi
object
required