---
title: "Get all time-offs"
method: GET
path: "/1.0/time-offs"
tags: ["Time-Offs"]
---

# Get all time-offs

`GET /1.0/time-offs`

## Query parameters

- `pageSize` number
- `pageToken` string
- `includeFields` string[]
- `includeAllFields` boolean
- `sortBy` 'startDate' | 'endDate' | 'createdAt'
- `sortOrder` 'ASC' | 'DESC'
- `match` 'all' | 'any'
- `startDate.gt` string
- `startDate.eq` string
- `startDate.lt` string
- `startDate.ge` string
- `startDate.le` string
- `endDate.gt` string
- `endDate.eq` string
- `endDate.lt` string
- `endDate.ge` string
- `endDate.le` string
- `type.eq` string[]
- `type.oneOf` string[]
- `type.noneOf` string[]
- `userId.eq` string
- `userId.oneOf` string
- `userId.noneOf` string
- `emailId.eq` string
- `emailId.oneOf` string
- `emailId.noneOf` string

## Response `200`

The requested action was successfully executed.

- ExampleAPIResponseTimeOffs
  - `data` TimeOffPublicAPIResponseForExample[] — Reflects all the default and custom fields and their values for the object searched, in an array format. If the includeFields param is utilised in the request body, it will return a customised response.
    - `timeOffId` integer — The unique `identifier` of the time-off is generated by the system and used to identify the time-off globally.
    - `user` TimeOffUserPublicAPIResponseEntity — The time-off user.
      - `emailId` string — The user's email identifier.
      - `userId` integer — The unique identifier for the customer.
      - `firstName` string — The first name of the customer.
      - `lastName` string — The last name of the customer.
    - `note` string — The note or comment about the time-off.
    - `startDate` string — The time-off start date. The format for the start date is _YYYY-MM-DD_.
    - `endDate` string — The time-off end date. The `endDate` must be on or after the `startDate`, formatted as _YYYY-MM-DD_.
    - `durationInMinutes` integer — The `durationInmMinutes` per day for applied time off interval. For `FULL_DAY` time off, the duration is calculated as `CAPACITY_IN_MINUTES / WORKING_DAYS_OF_WEEK`, while for `HALF_DAY` time off, it is calculated as `(CAPACITY_IN_MINUTES / WORKING_DAYS_OF_WEEK) / 2`. These calculations are based on the user's defined capacity.
    - `type` 'FULL_DAY' | 'HALF_DAY' | 'CUSTOM' — The `type` of the time-off.
    - `notifyUsers` TImeOffNotifyUsersPublicAPIResponse — Users to notify about your time off.
      - `projectOwners` boolean — Notify project owners of projects I'm part of.
      - `others` TimeOffOtherUsersPublicAPIResponse[] — Users to notify about your time off.
        - `emailId` string — The email identifier of the user.
        - `userId` integer — The user's unique, system-generated identifier, which can be used to identify the user globally.
        - `firstName` string — The first name of the user.
        - `lastName` string — The last name of the user.
    - `createdAt` integer — The timestamp when the time-off was created, represented in epoch milliseconds.
    - `createdBy` TimeOffCreatedByPublicResponse — The team member who created the time off.
      - `emailId` string — The team members email identifier.
      - `userId` integer — The unique identifier for the user.
      - `firstName` string — The first name of the user.
      - `lastName` string — The last name of the user.
  - `pagination` ExamplePaginationTimeOffs — Responses that return multiple objects will be paginated. The pagination params define how pages are structured and how to traverse through pages.
    - `pageSize` integer — Denotes the page size mentioned in the current request (limit). It defaults to 100 if left blank.
    - `hasMore` boolean — Tells us if there is more content.
    - `totalRecordCount` integer — Denotes the total resources matching the filters.
    - `nextPage` string — Denotes an API URL, which can be conveniently called to perform the subsequent search call to get to the next page.
    - `nextPageToken` string — Denotes a unique token that points to the next page of resources. To get results from subsequent pages, you can use the nextPageToken available in the response under pagination. This token is valid for 15 minutes.

## Other responses

- `400` — This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
- `401` — You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.

---

[API](https://skmtc.net/rocketlane/apis/rocketlane-api.md) · [All operations](https://skmtc.net/rocketlane/apis/rocketlane-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rocketlane/rocketlane-api/versions/1e8ba619e741/schema)