Gets the periods of unavailability for persons in the given account

By default this endpoint will return only Periods of Unavailability.
NOTE: If you wish to retrieve Pre and Post employment dates you will need to pass the "type" param in the query.

NOTE: If you do not have Private Read permissions, description will return as null for private periods of unavailability.
Permissions
Person: Read
HourlyProfile: Read
Unavailabilities: Read
HourlyUnavailabilities: Read
Private: Read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The Account ID

Query Params
date-time

Date from which to start the range (Default: 0001-01-01)

date-time

Date from which to end the range (Default: 9999-12-31)

boolean
Defaults to false

Setting this value to true will truncate the dates returned to the specified start and end date paramters

string
enum
Defaults to Unavailability, TimeOff

Type of the unavailability date range (Default: Unavailability)

Allowed:
string
enum
Defaults to Active

State of persons to filter results by (Default: Active)

Allowed:
personIds
array of int64s

Optional comma delimited list of person IDs to filter the results if set

personIds
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Bad Request: Example when end date before start date:
{

401

Unauthorized

403

Forbidden

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json