---
title: "Create a time off request"
method: POST
path: "/v1/org/{orgId}/timeoff"
tags: ["timeoff"]
---

# Create a time off request

`POST /v1/org/{orgId}/timeoff`

## Path parameters

- `orgId` string, required

## Request body

- CreateTimeOffEntity
  - `orgId` string, required — org that the time off belongs to
  - `personId` string, required — person taking the time off
  - `externalId` string — external identifier, if time off synced from external system
  - `startDate` string, date, required — start date of time off, inclusive
  - `startDatePartialDay` number — portion of the start date to take
  - `startDatePartialDayPeriod` 'AM' | 'PM' — Portion of the start day requested (e.g. AM or PM)
  - `endDate` string, date, required — end date of time off, inclusive
  - `endDatePartialDay` number — portion of the end date to take
  - `endDatePartialDayPeriod` 'AM' | 'PM' — Portion of the end day requested (e.g. AM or PM)
  - `days` number — number of days used
  - `hours` number — number of hours used
  - `typeDescription` string — type of time off
  - `timeOffPolicyId` string — policy id to pull the balance from
  - `note` string — notes on the time off
  - `approval` 'APPROVED' | 'PENDING' | 'CANCELLED' | 'REJECTED' | 'SUPERSEDED' — approval status of the time off
  - `requestAt` string — requested at timestamp -- often the same as createAt

## Response `201`

time off created

- TimeOff
  - `id` string, required — unique id of a time off request
  - `startDate` string, date, required — start date of time off, inclusive
  - `endDate` string, date, required — end date of time off, inclusive
  - `days` number — number of days used
  - `hours` number — number of hours used
  - `type` string — type of time off
  - `note` string — notes on the time off
  - `approval` 'APPROVED' | 'PENDING' | 'CANCELLED' | 'REJECTED' | 'SUPERSEDED' — approval status of the time off

## Other responses

- `400` — bad request
- `401` — not authorized
- `404` — not found
- `500` — Not Implemented

---

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