--- title: "List Time Off Requests" method: GET path: "/hris/time-off-requests" tags: ["Time Off Requests"] --- # List Time Off Requests `GET /hris/time-off-requests` List Time Off Requests ## Query parameters - `raw` boolean - `cursor` string, nullable - `limit` integer - `filter` TimeOffRequestsFilter - `start_date` string — Start date of the date range to filter time off requests. When used with end_date, filters for requests within the specified date range. - `end_date` string — End date of the date range to filter time off requests. When used with start_date, filters for requests within the specified date range. - `updated_since` string — Minimum date the time off request was last created or modified - `employee_id` string — Employee ID - `time_off_request_status` 'requested' | 'approved' | 'declined' | 'cancelled' | 'deleted' | 'other' — Time off request status to filter on - `company_id` string — Company ID - `pass_through` PassThroughQuery - `example_downstream_property` string — All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads) - `fields` string, nullable ## Headers - `x-apideck-consumer-id` string, required - `x-apideck-app-id` string, required - `x-apideck-service-id` string ## Response `200` TimeOffRequests - GetTimeOffRequestsResponse - `status_code` integer, required — HTTP Response Status Code - `status` string, required — HTTP Response Status - `service` string, required — Apideck ID of service provider - `resource` string, required — Unified API resource name - `operation` string, required — Operation performed - `data` TimeOffRequest[], required - `id` string — A unique identifier for an object. - `employee_id` string, nullable — ID of the employee - `policy_id` string, nullable — ID of the policy - `status` 'requested' | 'approved' | 'declined' | 'cancelled' | 'deleted' | 'other', nullable — The status of the time off request. - `description` string, nullable — Description of the time off request. - `start_date` string, nullable — The start date of the time off request. - `end_date` string, nullable — The end date of the time off request. - `request_date` string, nullable — The date the request was made. - `request_type` 'vacation' | 'sick' | 'personal' | 'jury_duty' | 'volunteer' | 'bereavement' | 'other', nullable — The type of request - `approval_date` string, nullable — The date the request was approved - `units` 'days' | 'hours' | 'other', nullable — The unit of time off requested. Possible values include: `hours`, `days`, or `other`. - `amount` number, nullable — The amount of time off requested. - `day_part` string, nullable — The day part of the time off request. - `notes` object - `employee` string, nullable - `manager` string, nullable - `custom_mappings` CustomMappings, nullable — When custom mappings are configured on the resource, the result is included here. - `updated_by` string, nullable — The user who last updated the object. - `created_by` string, nullable — The user who created the object. - `updated_at` string, date-time, nullable — The date and time when the object was last updated. - `created_at` string, date-time, nullable — The date and time when the object was created. - `pass_through` object[] — The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. - `service_id` string, required — Identifier for the service to which this pass_through should be applied. - `operation_id` string — Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request. - `extend_object` object — Simple object allowing any properties for direct extension. - `extend_paths` object[] — Array of objects for structured data modifications via paths. - `path` string, required — JSONPath string specifying where to apply the value. - `value` unknown, required - `policy_type` string — The policy type of the time off request - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided - `meta` Meta — Response metadata - `items_on_page` integer — Number of items returned in the data property of the response - `cursors` object — Cursors to navigate to previous or next pages through the API - `previous` string, nullable — Cursor to navigate to the previous page of results through the API - `current` string, nullable — Cursor to navigate to the current page of results through the API - `next` string, nullable — Cursor to navigate to the next page of results through the API - `total_count` integer — Number of records available in total for this resource - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200. - `type` string — Discriminator for the warning kind. - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available. - `error` string, nullable — Short error description from the downstream provider, when available. - `operation` string, nullable — Identifier of the workflow step that failed. - `message` string, nullable — Detailed message from the downstream provider, when available. - `links` Links — Links to navigate to previous or next pages through the API - `previous` string, nullable — Link to navigate to the previous page through the API - `current` string — Link to navigate to the current page through the API - `next` string, nullable — Link to navigate to the previous page through the API ## Other responses - `400` — Bad Request - `401` — Unauthorized - `402` — Payment Required - `404` — The specified resource was not found - `422` — Unprocessable - `default` — Unexpected error --- [API](https://skmtc.net/apideck-libraries/apis/hris-api.md) · [All operations](https://skmtc.net/apideck-libraries/apis/hris-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apideck-libraries/hris-api/versions/e16521ae2068/schema)