Search employee calendars

post

https://api.hibob.com/v1/timeoff/calendars/employees/search

Body Params

Request body for employee-calendar search. filters is required and must always include at least one filter on /employeeCalendar/employeeId (the batch of employees to resolve). fields is optional — omit it to return every field; limit and cursor are optional and fall back to server defaults (see examples for typical payloads).

fields

array of objects | null

Defaults to /employeeCalendar/employeeId,/employeeCalendar/calendarId,/employeeCalendar/calendarName,/employeeCalendar/source,/employeeCalendar/siteId

fields

filters

array of objects

required

length ≥ 1

Defaults to [object Object]

filters*

fieldId

string

enum

required

Allowed:

operator

string

required

length between 1 and 64

values

array of strings

required

values*

limit

integer | null

1 to 1000

Defaults to 100

cursor

string | null

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad request — the request was malformed or missing required parameters

401Unauthorized — authentication credentials are missing or invalid

403Forbidden — the authenticated user does not have permission to perform this operation

429Too many requests — rate limit exceeded, retry after the indicated delay

500Internal server error — an unexpected error occurred on the server