Create Time Off Request

post

https://{companyDomain}.bamboohr.com/api/v1/time-off/requests

Creates a time off request on behalf of an employee. The request is created with status REQUESTED and enters the approval workflow.

OAuth Scopes: time_off:requests.write

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

returnActions

boolean

Defaults to false

Set to true to include the _links block naming the state transitions available to the caller for this time off request. Also accepts 1, yes and on. Omitted from the response by default.

Body Params

Data contract for creating a time off request on behalf of an employee. Exactly one of 'amount' or 'dailyAmounts' must be supplied.

employeeId

integer

required

The id of the employee the time off is requested for.

categoryId

integer

required

The id of the time off category for the request.

startDate

date

required

The date the time off starts, in ISO 8601 format (YYYY-MM-DD).

endDate

date

required

The date the time off ends (inclusive), in ISO 8601 format (YYYY-MM-DD).

employeeNote

length ≤ 1024

An optional note from the requester. Maximum 1024 characters.

amount

The total amount of time off requested for the whole range, in the category's unit. Supply exactly one of 'amount' or 'dailyAmounts'.

dailyAmounts

The per-day amounts of time off requested, each within the request date range. Supply exactly one of 'amount' or 'dailyAmounts'.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201The time off request was created.

400Malformed request body.

401Unauthorized. Missing or invalid authentication.

403Forbidden. The caller cannot record time off for this employee.

404The employee or category does not exist.

422Invalid request data (e.g. invalid dates, out-of-range daily amounts, inactive/unenrolled category, or an overlapping request).