---
title: "Get all time off requests on a workspace"
method: POST
path: "/v1/workspaces/{workspaceId}/time-off/requests"
tags: ["Time Off"]
---

# Get all time off requests on a workspace

`POST /v1/workspaces/{workspaceId}/time-off/requests`

## Path parameters

- `workspaceId` string, required — Represents a workspace identifier across the system.

## Request body

- GetTimeOffRequestsV1Request
  - `end` string, date-time — Provide the end of the filtering period. Used with `start` to filter for time-off requests periods that occur (fully or partially) within this range. Both parameters must be provided for filtering to take effect. Provide end in format YYYY-MM-DDTHH:MM:SS.ssssssZ
  - `page` integer — Page number.
  - `pageSize` integer — Page size.
  - `start` string, date-time — Provide the beginning of the filtering period. Used with `end` to filter for time-off requests periods that occur (fully or partially) within this range. Both parameters must be provided for filtering to take effect. Provide start in format YYYY-MM-DDTHH:MM:SS.ssssssZ
  - `statuses` string[] — Filters time off requests by status.
  - `userGroups` string[] — Provide the user group ids of time off requests.
  - `users` string[] — Provide the user ids of time off requests. If empty, will return time off requests of all users (with a maximum of 5000 users).

## Response `200`

OK

- TimeOffRequestsWithCountV1Dto
  - `count` integer — Total count of time off requests.
  - `requests` TimeOffRequestFullV1Dto[]
    - `balance` number, double — Represents the time off balance.
    - `balanceDiff` number, double — Represents the balance difference.
    - `createdAt` string, date-time — Represents the date when time off request is created. It is in format YYYY-MM-DDTHH:MM:SS.ssssssZ
    - `id` string — Represents time off requester identifier across the system.
    - `note` string — Represents the note of the time off request.
    - `policyId` string — Represents policy identifier across the system.
    - `policyName` string — Represents the policy name of the time off request.
    - `requesterUserId` string — Represents requester user's id.
    - `requesterUserName` string — Represents requester user's username.
    - `status` TimeOffRequestStatus — Represents the status the time off request.
      - `changedAt` string, date-time
      - `changedByUserId` string
      - `changedByUserName` string
      - `changedForUserName` string
      - `note` string
      - `statusType` 'PENDING' | 'APPROVED' | 'REJECTED' | 'ALL'
    - `timeOffPeriod` TimeOffRequestPeriodDto — Represents the period the time off request.
      - `halfDay` boolean
      - `halfDayHours` Period
        - `end` string, date-time
        - `start` string, date-time
      - `halfDayPeriod` string
      - `period` Period
        - `end` string, date-time
        - `start` string, date-time
    - `timeUnit` 'DAYS' | 'HOURS' — Represents the time unit of the time off request.
    - `userEmail` string — Represents user's email
    - `userId` string — Represents user identifier across the system.
    - `userName` string — Represents user's username.
    - `userTimeZone` string — Represents user's time zone
    - `workspaceId` string — Represents workspace identifier across the system.

---

[API](https://skmtc.dev/clockify/apis/clockify-api.md) · [All operations](https://skmtc.dev/clockify/apis/clockify-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/clockify/clockify-api/revisions/a5b636acbcd8/schema)