Deel Documents List
CertifiedList EOR Contract Documents
Deel Documents List
List EOR Contract Documents
List HRX documents shared with an employee under an EOR contract. Requires the worker: read and contracts: read scopes. Supports cursor-based pagination.
type: io.kestra.plugin.deel.documents.ListExamples
List documents for an EOR contract
id: list_documents
namespace: company.team
tasks:
- id: list_documents
type: io.kestra.plugin.deel.documents.List
apiToken: "{{ secret('DEEL_API_TOKEN') }}"
contractId: "5B74FnLM"
fetchType: FETCH
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
apiToken *string
Deel API token
API token for authentication. Can be an organization token, personal token, or worker token.
apiVersion string
2026-01-01API version
API version header value. Defaults to 2026-01-01.
assets
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.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset 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.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150baseUrl string
https://api.letsdeel.com/restDeel API base URL
Base URL for the Deel API. Use https://api-sandbox.demo.deel.com/rest for sandbox environment.
contractId string
Contract ID
The unique identifier of the EOR employee contract.
cursor string
Cursor for pagination
Cursor for pagination. Use the cursor from the previous response to get the next page of results.
fetchType string
FETCHSTOREFETCHFETCH_ONENONEResult 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.
limit integerstring
20Maximum number of documents per page
Number of items to return per page. Maximum is 100, default is 20.
Outputs
row object
First document
Available only when fetchType=FETCH_ONE; contains the first document.
rows array
Fetched documents
Available only when fetchType=FETCH; contains documents for the current response page.
size integer
Number of documents returned in this response
Number of documents included in outputs for the selected fetch type.
total integer
Total number of documents
Total documents reported by the API, regardless of pagination.
uri string
uriStored documents URI
Available only when fetchType=STORE; Kestra internal storage path to the Ion file.
