---
title: "Return a list of time-off requests."
method: GET
path: "/time-off/requests"
tags: ["Time off"]
---

# Return a list of time-off requests.

`GET /time-off/requests`

This endpoint returns a paginated list of time off requests for a given date range.The maximum number of time off requests to retrieve once is 92 days, so the URL params *from* and *to* are mandatory. The URL params help to return more accurate results.

## Query parameters

- `from` string, required
- `to` string, required
- `_userId` string
- `_timeOffTypeId` string
- `status` 'Approved' | 'Declined' | 'Cancelled' | 'Pending' | 'Submitted' | 'Processed' | 'CancelledAfterProcessed' | 'InApproval'
- `offset` number
- `limit` number

## Headers

- `Authorization` string, required

## Response `200`

OK.

- object
  - `data` object[]
    - `_id` string — The Kenjo _id of the returned time-off request.
    - `_userId` string — The employee id associated to the time-off request.
    - `_timeOfTypeId` string — The time-off type id associated to the time-off request.
    - `_policyId` string — The policy id associated to the time-off request.
    - `policyName` string — The name of the policy id associated to the time-off request.
    - `_policyType` string — The type of the policy associated to the time-off request. It can be type *Hour* or *Day*.
    - `status` string — The status of the time-off request.
    - `from` string — The from date of the time-off request in format YYYY-MM-DDThh:mm:ss.
    - `to` string — The to date of the time-off request in format YYYY-MM-DDThh:mm:ss.
    - `duration` number — The duration of the time-off request. It doesn't exclude bank holidays nor non-working days.
    - `workingTime` number — The duration of the time-off request. It excludes bank holidays and non-working days.
    - `_createdAt` string — The date that the time-off request was created in format YYYY-MM-DDThh:mm:ss.
    - `description` string — The provided description on the time-off request.
    - `hasAttachment` boolean — Determines if the time-off request has related attachments.
    - `_type` string — This field defines if the request is a 'Submission' or a 'Request'. By default, the 'Submission' is automatically approved.
  - `metadata` object
    - `count` number — The number of rows retrieved according the pagination filters (limit + offset).
    - `offset` number — The number of pages to skip. Determines the page number when pagination is being used.
    - `limit` number — The maximum number of rows to retrieve. Determines the size of the page when pagination is being used.
    - `total` number — The total number of rows existing for the provided filters.

## Other responses

- `400` — BAD REQUEST. This is a wrong request in the client side due to invalid body or params.
- `401` — UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired.

---

[API](https://skmtc.net/kenjo/apis/kenjo-api.md) · [All operations](https://skmtc.net/kenjo/apis/kenjo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kenjo/kenjo-api/revisions/58772b78268e/schema)