v3

latestSwagger 2.02026-08-067506752.0 MB

timeoff

Request time off

post/v1/org/{orgId}/timeoff/request

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

startDatestring date required

startDatePartialDaynumber

startDatePartialDayPeriod'AM' | 'PM'

endDatestring date required

endDatePartialDaynumber

endDatePartialDayPeriod'AM' | 'PM'

personIdstring

typeDescriptionstring

timeOffPolicyIdstring

notestring

Example request

{
  "personId": "588f7ee98f138b19220041a7",
  "timeOffPolicyId": "588f7ee98f138b19220041a7"
}

Response

time off created

idstring required

globally unique id of time off

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

approvalAtstring

timestamp of approval

approvalUserIdstring

user who either is the next one requesting approval, or the user who did the final approval or rejection

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateAtstring

updated timestamp

updateIdstring

updated by user id

updateBehalfIdstring

last updated on behalf of user id

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

requestAtstring

requested at timestamp -- often the same as createAt

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "personId": "588f7ee98f138b19220041a7",
  "timeOffPolicyId": "588f7ee98f138b19220041a7",
  "approvalAt": "2017-01-24T13:57:52Z",
  "approvalUserId": "588f7ee98f138b19220041a7",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z",
  "requestAt": "2017-01-24T13:57:52Z"
}