Skip to content

ActualTimeOff

Actual Time Off represents recorded time off entries for employees, capturing the date, duration, and category of time off taken. Use these endpoints to create, retrieve, update, and delete actual time off records.

Operations

List Actual Time Off

Request

Gets a paginated list of actual time off entries with optional filtering by date range and person. When no start or end date filters are provided, returns entries from the last 7 days (7 days ago through today).

Security
ApiKey
Query
pageinteger, (int32)

The specific page of results requested.

page_sizeinteger, (int32)

The number of results in each page.

person_idstring, (uuid)

Filter results to a specific person.

start_datestring, (date)

Filter by entries recorded on or after this date. When not provided, defaults to 7 days ago from today. ISO date formatting expected (yyyy-MM-dd)

end_datestring, (date)

Filter by entries recorded on or before this date. When not provided, defaults to today. ISO date formatting expected (yyyy-MM-dd)

curl -i -X GET \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/actual-time-off?page=0&page_size=0&person_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&start_date=2019-08-24&end_date=2019-08-24' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
countinteger, (int64)

The number of results in the current page.

totalinteger, (int64)

The total number of results that fulfill the request.

pageinteger, (int64)

The current page of results being returned.

total_pagesinteger, (int64)

The total number of available pages that fulfill the request.

page_sizeinteger, (int64)

The number of results in each page returned.

resultsArray of objects(ActualTimeOff)required

The array of result objects for the current page.

Response
{
  "count": 0,
  "total": 0,
  "page": 0,
  "total_pages": 0,
  "page_size": 0,
  "results": [
    { … }
  ]
}