v3

latestSwagger 2.02026-08-067506752.0 MB
Time off ledger

Query time off ledger entries in the organization, returning particular time off, job, and person data fields

get/v1/org/{orgId}/timeoff-ledger/data

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

fieldsstring

Fields to retrieve, comma-separated

fromDatestring date required

From date, inclusive

untilDatestring date required

Until date, exclusive

filterstring

Filter to apply on the person

personIdstring

If retrieving from specific people, their personIds, comma-separated

policyIdstring

If retrieving for specific time off policies, the policyIds, comma-separated

formatstring

Data format to use; default is json, can also use json-extended or json-readable

splitColumnsboolean

Whether to split complex columns, used for tabular data formats

Response

ledger entries found

dataobject[] required
nextstring
totalRowobject

Example response

{
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}