v1
latestOpenAPI 3.0.12026-07-2464217456.8 KBGet all time-offs
Query parameters
This parameter sets the maximum number of responses to be displayed per page. If the page size is insufficient to accommodate the whole number of responses obtained, the pagination object will include a link to the next page as well as the next page token. If left blank, it defaults to 100.
Use this parameter to specify the pageToken of a page to which you want to navigate. This pageToken can be obtained from a previous request which specified a limit and will only be active for 15 minutes after it is created.
This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned.
This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.
You can use the sortBy param to sort the responses by the given field.
The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.
You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.
Returns responses with start dates greater than the specified date.
Returns responses with start dates equal to the specified date.
Returns responses with start dates lesser than the specified date.
Returns responses with start dates greater than or equal to the specified date.
Returns responses with start dates lesser than or equal to the specified date.
Returns responses with start dates greater than the specified date.
Returns responses with start dates equal to the specified date.
Returns responses with start dates lesser than the specified date.
Returns responses with start dates greater than or equal to the specified date.
Returns responses with start dates lesser than or equal to the specified date.e.
Returns responses with time-offs that exactly match the specified time off type.
Returns responses with time-offs that matches one of the specified time off type.
Returns responses with time-offs that matches none of the specified time off type.
Returns responses with time-offs that exactly match the specified user id.
Returns responses with time-offs that matches one of the specified user id.
Returns responses with time-offs that matches none of the specified user id.
Returns responses with time-offs that exactly match the specified user's email id.
Returns responses with time-offs that matches one of the specified user's email ids.
Returns responses with time-offs that matches none of the specified user's email ids.
Response
The requested action was successfully executed.
Example response
{
"data": [
{
"timeOffId": 201,
"user": {
"emailId": "john.doe@rocketlane.com",
"userId": 201,
"firstName": "John",
"lastName": "Doe"
},
"note": "Sick leave.",
"startDate": "2023-03-28",
"endDate": "2023-03-28",
"durationInMinutes": 50,
"type": "FULL_DAY",
"notifyUsers": {
"others": [
{
"emailId": "john.doe@rocketlane.com",
"userId": 201,
"firstName": "John",
"lastName": "Doe"
}
]
},
"createdAt": 1681319726000,
"createdBy": {
"emailId": "john.doe@rocketlane.com",
"userId": 201,
"firstName": "John",
"lastName": "Doe"
}
}
],
"pagination": {
"pageSize": 100,
"hasMore": true,
"totalRecordCount": 10398,
"nextPage": "https://api.rocketlane.com/api/1.0/time-offs?includeFields=note&sortBy=start&sortOrder=desc&pageToken=e4a3dd8e-e338-11ed-b5ea-0242ac120002&limit=100",
"nextPageToken": "e4a3dd8e-e338-11ed-b5ea-0242ac120002"
}
}