Deel Time Off List

Deel Time Off List

Certified

List Time Off Requests

List time-off requests for a single worker profile. Requires the time-off: read scope. Supports cursor-based pagination via page size and next token.

yaml
type: io.kestra.plugin.deel.timeoff.List

List time-off requests for a profile

yaml
id: list_time_offs
namespace: company.team
tasks:
  - id: list_time_offs
    type: io.kestra.plugin.deel.timeoff.List
    apiToken: "{{ secret('DEEL_API_TOKEN') }}"
    hrisProfileId: "d290f1ee-6c54-4b01-90e6-d701748f0851"
    fetchType: FETCH

List approved time off in a date range

yaml
id: list_approved_time_offs
namespace: company.team
tasks:
  - id: list_time_offs
    type: io.kestra.plugin.deel.timeoff.List
    apiToken: "{{ secret('DEEL_API_TOKEN') }}"
    hrisProfileId: "d290f1ee-6c54-4b01-90e6-d701748f0851"
    status: "APPROVED"
    startDate: "2024-01-01"
    endDate: "2024-12-31"
    fetchType: STORE
Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command: 

kestractl plugins get io.kestra.plugin:plugin-deel --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

Deel API token

API token for authentication. Can be an organization token, personal token, or worker token.

HRIS profile ID

Worker HRIS profile id identifying the profile whose time-off requests are returned.

Default2026-01-01

API version

API version header value. Defaults to 2026-01-01.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaulthttps://api.letsdeel.com/rest

Deel API base URL

Base URL for the Deel API. Use https://api-sandbox.demo.deel.com/rest for sandbox environment.

Filter by end date

End date of time off.

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

Result handling mode

Controls how hits are exposed in outputs. FETCH returns all hits in the response. FETCH_ONE returns only the first hit. STORE writes hits to Kestra storage and returns a URI. NONE leaves outputs empty.

Next page cursor

Cursor for the next page, as returned by a previous response.

Page size

Number of time-off requests to return per page.

Filter by start date

Start date of time off.

Filter by status

Time off status (REQUESTED, APPROVED, REJECTED, USED, CANCELED).

Next page token

Token for the next page, as returned by the API.

Next page cursor

Cursor for the next page of results. Returned when more pages are available.

First time-off request

Available only when fetchType=FETCH_ONE; contains the first time-off request.

SubTypeobject

Fetched time-off requests

Available only when fetchType=FETCH; contains time-off requests for the current response page.

Number of time-off requests returned in this response

Number of time-off requests included in outputs for the selected fetch type.

Total number of time-off requests

Total time-off requests reported by the API, regardless of pagination.

Formaturi

Stored time-off requests URI

Available only when fetchType=STORE; Kestra internal storage path to the Ion file.

More Plugins in this Category

Dataform
Dataform

Tasks that run Dataform data transformations through the Dataform CLI.

Data

1 tasks

6 blueprints

Google Workspace
Google Workspace

Tasks that work with Google Workspace services (Chat, Drive, Calendar, Mail, Sheets).

BusinessData

25 tasks

13 blueprints