Deel Documents Download

Deel Documents Download

Certified

Download EOR Contract Document

Download an HRX document for an EOR contract. The API returns a pre-signed URL; the file content is stored in Kestra storage. Requires the contracts: read and worker: read scopes.

yaml
type: io.kestra.plugin.deel.documents.Download

Download a contract document

yaml
id: download_document
namespace: company.team
tasks:
  - id: download_document
    type: io.kestra.plugin.deel.documents.Download
    apiToken: "{{ secret('DEEL_API_TOKEN') }}"
    contractId: "123E4567"
    documentId: "123e4567-e89b-12d3-a456-426614174000"
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.

Contract ID

The unique identifier of the EOR employee contract.

Document ID

The unique identifier of the document to download.

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.

Contract ID

The EOR contract the document belongs to.

Document ID

The downloaded document.

File size in bytes

Size of the downloaded file.

Formaturi

Stored document URI

Kestra internal storage path to the downloaded 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