Create time off request

post

https://api.connecteam.com/time-off/v1/requests

Create a new time-off request for a user under a specified policy. The time-off request can be either in pending or approved status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request model for the new Time Off Request

timeClockId

integer

The unique identifier of the time clock where the time off will be presented in the timesheet

userId

integer

required

≥ 1

The ID of the user to create the time off request

policyTypeId

string

required

The ID of the policy type

isAllDay

boolean

required

Specifies the type of the time period. Defaults to true. If set to false, start and end time fields must be specified.

startDate

string

required

The start date of the time off in ISO format (YYYY-MM-DD)

endDate

string

required

The end time of the time off in ISO format (YYYY-MM-DD). End date must be similar to Start date if isAllDay set to false.

startTime

string

The start time of the time off in ISO format (HH:MM:SS). This field is required if isAllDay set to false.

endTime

string

The end time of the time off in ISO format (HH:MM:SS). This field is required if isAllDay set to false.

timezone

string

required

The timezone in Tz format (e.g. America/New_York)

status

string

enum

required

The status of the time off request.

Allowed:

employeeNote

string

Employee note providing additional details

managerNote

string

Manager note providing additional details

isAdjustForDayLightSaving

boolean

Defaults to false

Specifies if the time given should offset the daylight savings time change if the time falls exactly on the daylight savings time change. Set to true only if the time coincides with the rollback hour, otherwise, it should remain false.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error