COconnecteam
Time Off:v1:TimeOffRequests

Create time off request

Changed on

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.

post/time-off/v1/requests

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/time-off/v1/requests
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: time_off.write

Request body

timeClockIdinteger

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

userIdinteger required

The ID of the user to create the time off request

policyTypeIdstring required

The ID of the policy type

isAllDayboolean required

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

startDatestring required

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

endDatestring 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.

startTimestring

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

endTimestring

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

timezonestring required

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

status'approved' | 'pending' | 'denied' required

The status of the time off request.

employeeNotestring

Employee note providing additional details

managerNotestring

Manager note providing additional details

isAdjustForDayLightSavingboolean

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.

Response

Successful Response

requestIdstring

Changes