Skip to main content
GET
/
api
/
v1
/
persons
/
{personId}
/
time-off-balances
cURL
curl --request GET \
  --url https://api.example.com/api/v1/persons/{personId}/time-off-balances
{
  "personId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "balances": [
    {
      "id": "flexibleworktime",
      "balance": 123,
      "used": 123,
      "unit": "HOURS"
    }
  ]
}
We identified that this endpoint mixes two different concepts: time account and balance. We are currently working on a new design that will separate these concepts and provide a more consistent and intuitive API. While you can already use this endpoint, it will receive breaking changes that we will announce in the changelog. We recommend waiting for the new design to be released before using this endpoint in production.
Our time management system supports absences in a highly flexible manner. Any booking key can be recorded as an absence, provided it is configured accordingly. Therefore, there are no fixed types of absence or time accounts.

Path Parameters

​
personId
string
required

Response

200 - application/json

OK

Time off balances for a person

​
personId
string<uuid>
​
balances
object[]