Skip to main content
GET
Org-wide payslips browser (filters

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

page
integer
default:1
Required range: 1 <= x <= 9007199254740991
pageSize
integer
default:50
Required range: 1 <= x <= 100
month
string
Pattern: ^\d{4}-\d{2}$
status
enum<string>
Available options:
Paid,
Processing,
Pending
q
string
Maximum string length: 80
departmentId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

200 - application/json

Success

items
object[]
required
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
page
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
pageSize
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
months
string[]
required
grossTotal
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
netTotal
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991