Deel Contracts ContractsList

Deel Contracts ContractsList

Certified

List Contracts

List contracts with their details. Supports cursor-based pagination.

yaml
type: io.kestra.plugin.deel.contracts.ContractsList

List all contracts

yaml
id: list_contracts
namespace: company.team
tasks:
  - id: list_contracts
    type: io.kestra.plugin.deel.contracts.ContractsList
    apiToken: "{{ secret('DEEL_API_TOKEN') }}"
    limit: 50
    fetchType: FETCH

List active contracts with filters

yaml
id: list_active_contracts
namespace: company.team
tasks:
  - id: list_contracts
    type: io.kestra.plugin.deel.contracts.ContractsList
    apiToken: "{{ secret('DEEL_API_TOKEN') }}"
    status: "active"
    limit: 25
    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.

Cursor for pagination

Cursor for the next page (cursor-based pagination).

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 contract type

Filter contracts by type (e.g., open, terminated, expired).

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.

Filter by legal entity ID

Filter contracts by legal entity ID.

Default25

Maximum number of contracts per page

Number of contracts to return per page (max 100). Default is 25.

Filter by status

Filter contracts by status (e.g., active, terminated).

Filter by team ID

Filter contracts by team ID.

Filter by updated since

Filter contracts updated since the given timestamp (ISO 8601 format).

Next page cursor

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

First contract

Available only when fetchType=FETCH_ONE; contains the first contract.

SubTypeobject

Fetched contracts

Available only when fetchType=FETCH; contains contracts for the current response page.

Number of contracts returned in this response

Number of contracts included in outputs for the selected fetch type.

Total number of contracts

Total contracts reported by the API, regardless of pagination.

Formaturi

Stored contracts URI

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