timeoff

Create a time off request

post/v1/org/{orgId}/timeoff

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/timeoff
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

orgIdstring required

org that the time off belongs to

personIdstring required

person taking the time off

externalIdstring

external identifier, if time off synced from external system

startDatestring date required

start date of time off, inclusive

startDatePartialDaynumber

portion of the start date to take

startDatePartialDayPeriod'AM' | 'PM'

Portion of the start day requested (e.g. AM or PM)

endDatestring date required

end date of time off, inclusive

endDatePartialDaynumber

portion of the end date to take

endDatePartialDayPeriod'AM' | 'PM'

Portion of the end day requested (e.g. AM or PM)

daysnumber

number of days used

hoursnumber

number of hours used

typeDescriptionstring

type of time off

timeOffPolicyIdstring

policy id to pull the balance from

notestring

notes on the time off

approval'APPROVED' | 'PENDING' | 'CANCELLED' | 'REJECTED' | 'SUPERSEDED'

approval status of the time off

requestAtstring

requested at timestamp -- often the same as createAt

Example request

{
  "orgId": "588f7ee98f138b19220041a7",
  "personId": "588f7ee98f138b19220041a7",
  "timeOffPolicyId": "588f7ee98f138b19220041a7",
  "requestAt": "2017-01-24T13:57:52Z"
}

Response

time off created

idstring required

unique id of a time off request

startDatestring date required

start date of time off, inclusive

endDatestring date required

end date of time off, inclusive

daysnumber

number of days used

hoursnumber

number of hours used

typestring

type of time off

notestring

notes on the time off

approval'APPROVED' | 'PENDING' | 'CANCELLED' | 'REJECTED' | 'SUPERSEDED'

approval status of the time off

Changes

No recorded changes to this operation across all 20 revisions of this API.