The Get all time-offs API enables users to get all time offs in their Rocketlane instances using advanced filtering options. This API is intended to provide a flexible and fast means of getting time off related data based on various parameters.

Developers can integrate the time off search feature into their applications and platforms by using this API. You can fine-tune your searches and retrieve the time offs related data you need for integration into your applications or platforms by using the available parameters.

You can use any combination of these parameters to execute searches based on your specifications. In addition to filters, sortBy and sortOrder can be used to sort the projects. The response body is paginated, and you can control the pagination using the limit and pageToken parameters.

Pagination

The Get all time-offs API accommodates pagination in the response body. The pageSize option can be used to restrict the amount of responses displayed/available in a single request. Additionally, if there are more entries than the ones accessible in the answer, the response(s) may contain the nextPageToken.

Please refer to the pagination section for further information on this.

Filtering

The capacity to execute more sophisticated and nuanced searches on a dataset by combining numerous criteria and conditions is referred to as filtering.

Complex filtering in the context of the Get all time-offs API allows users to build elaborate search queries to return specific subsets of time offs that satisfy specific requirements. By catering to a wide range of use cases, this enhanced filtering functionality considerably increases the API's utility and versatility.

The API reference includes a comprehensive range of filtering options.

Please refer to the link here for more information on how to construct the filtering criteria for time off related fields.

Criteria Match

In addition to standard filtering and custom field filtering, the Get all time-offs API also supports the use of AND and OR conditions for more advanced filtering options. Developers can combine different filters and custom field queries with these logical operators to build complex yet accurate search queries.

In case any issues arise or further assistance is required, please refer to the error handling section or reach out to our support team at care@rocketlane.com for a prompt resolution.