Skip to main content
GET
Statutory register statuses for a month

Authorizations

Authorization
string
header
required

Issue keys in Settings → API. Send them as Authorization: Bearer ont_… (an X-Api-Key: ont_… header is also accepted). Session-cookie routes are used by the OnTime web apps and are shown for completeness.

Query Parameters

month
string
required

Response

200 - application/json

Success

key
enum<string>
required
Available options:
muster,
wage,
ot,
leave,
sne
name
string
required
formNo
string
required
description
string
required
period
string
required
periodLabel
string
required
status
enum<string>
required
Available options:
UpToDate,
Stale,
Overdue,
NotGenerated
rowCount
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
generatedAt
string | null
required