v1
latestOpenAPI 3.0.02026-07-14800227.2 KBReturn a list of time-off types.
This endpoint returns a list of all the existing time off types for an organization. The URL params help to return more accurate results.
Query parameters
Optional filter. This field allows you to retrieve time-off types based on their name. It can accept two formats:<br><br> 1. A single name as a unique string. <br>Example: name=Sick <br><br> 2. Multiple name values separated by commas (up to a maximum of 15 values). <br>Example: name=Maternity,Sick,Home. These options provide flexibility in filtering contracts by their type, making it easier to retrieve the specific data you need.
Optional filter for pagination proposals. Determines the number of pages to skip when pagination is being used. If this value is not provided, by default the offset will be 1.
Optional filter for pagination proposals. The maximum number of rows to retrieve which determines the size of the page. If this value is not provided then the limit will be 50 users. The maximum value of the limit is 100 users per page. Only are valid the following limit values: 25, 50 and 100.
Headers
A valid bearer token.
Response
OK.
Example response
{
"data": [
{
"_id": "60a2db290da29e126a18789a",
"name": "Sick"
},
{
"_id": "60a2db290da29e126a18789f",
"name": "Maternity leave"
},
{
"_id": "60a2db290da29e126a18789d",
"name": "Holidays"
}
],
"metadata": {
"count": 2,
"offset": 1,
"limit": 50,
"total": 2
}
}