Skip to content

PlannedTimeOff

Planned Time Off represents approved time off requests for employees, each entry capturing the date range and category of planned time away from work. Each entry has a start and end date, and is intended to capture a contiguous period of absense. Use these endpoints to create, retrieve, update, and delete planned time off, allowing resource capacity to remain accurate for planning purposes.

Operations

List Planned Time Off

Request

Returns a paged list of planned time off filtered by date range. Optionally filtered to a single person.

Security
ApiKey
Query
pageinteger, (int32)

The specific page of results requested.

page_sizeinteger, (int32)

The number of results in each page.

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)

person_idstring, (uuid)

Filter by entries recorded for the Person associated with this person_id.

curl -i -X GET \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/planned-time-off?page=0&page_size=0&start_date=2019-08-24&end_date=2019-08-24&person_id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -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(PlannedTimeOff)required

The array of result objects for the current page.

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