Search calendar events

post

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

Body Params

Request body for calendar event search. filters is required and must always include a date range on /calendarEvent/startDate as a from/to pair (other filters may be added on top). fields is optional — omit it to return every field; limit and cursor are optional and fall back to server-defined paging (see examples for typical payloads).

fields

array of objects | null

Defaults to /calendarEvent/id,/calendarEvent/name,/calendarEvent/startDate,/calendarEvent/endDate,/calendarEvent/eventType,/calendarEvent/siteId

fields

filters

array of objects

required

length ≥ 2

Defaults to [object Object],[object Object]

filters*

fieldId

string

enum

required

Allowed:

operator

string

required

length between 1 and 64

values

array of strings

required

values*

fieldId

string

enum

required

Allowed:

operator

string

required

length between 1 and 64

values

array of strings

required

values*

limit

integer | null

1 to 500

Defaults to 50

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