Get Time Off Types

This endpoint gets a list of time off types.

Sample Response

{
   "timeOffTypes":    [
            {
         "id": "1",
         "name": "Vacation",
         "units": "hours",
         "color": "eef448",
         "icon": "palm-trees"
      },
   ],
   "defaultHours":    [
            {
         "name": "Saturday",
         "amount": "0"
      },
            {
         "name": "Sunday",
         "amount": "0"
      },
            {
         "name": "default",
         "amount": "8"
      }
   ]
}
<timeOffTypes>
    <timeOffType id="1">
        <name>Vacation</name>
        <units>days</units>
        <color>4aada4</color>
        <icon>time-off-luggage</icon>
    </timeOffType>
    <defaultHours>
        <weekDay name="Saturday" amount="0"/>
        <weekDay name="Sunday" amount="0"/>
        <weekDay name="default" amount="8"/>
    </defaultHours>
</timeOffTypes>

GET variables

mode (optional) - set to "request" to get a list of all time off types with which this user can create a time off request. The default is to return the list of time off types the user has permissions on. This distinction is important, as employees can request time off for types that they don't have permission to view balances and requests for.

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!