timeOff

List time-off requests

Use this endpoint to retrieve a specific worker's time-off history or upcoming requests — e.g. to build a worker-facing view, check availability before scheduling, or reconcile attendance during payroll. Unlike GET /rest/time_offs, which lists requests org-wide, this scopes to a single hris_profile_id. Combine the status, policy, and date-range filters to narrow results, and page through history with page_size and next.

Token scopes: time-off:read

get/time_offs/profile/{hris_profile_id}

Request

  • Base URL: https://api.letsdeel.com/rest
  • URL: https://api.letsdeel.com/rest/time_offs/profile/{hris_profile_id}
  • Auth: HTTP bearer

Path parameters

hris_profile_idstring uuid required

HRIS profile id

Query parameters

statusTimeOffsProfileHrisProfileIdGetParametersStatusSchemaItems[]

Time off status

time_off_idsstring[]

Time off ids

start_datestring date-time

Start date of time off

end_datestring date-time

End date of time off

approval_start_datestring date-time

Approval start date

approval_end_datestring date-time

Approval end date

updated_start_datestring date-time

Updated start date

updated_end_datestring date-time

Updated end date

page_sizeinteger

Page size

policy_typesstring[]

Policy types

policy_type_namesTimeOffsProfileHrisProfileIdGetParametersPolicyTypeNamesSchemaItems[]

Filter by policy type names. When omitted, Work Location time-offs are excluded by default. Pass policy_type_names=Work+Location to retrieve only Work Location entries.

nextstring

Next page

Response

Successful operation time offs returned

nextstring
countinteger

Total count of items

page_sizeinteger required

Page size

has_next_pageboolean required

Has next page

Changes

No recorded changes to this operation across all 1 revision of this API.