Deel Organization LegalEntities

Deel Organization LegalEntities

Certified

List Legal Entities

List legal entities in the account. Requires the organizations: read scope. Supports cursor-based pagination.

yaml
type: io.kestra.plugin.deel.org.LegalEntities

List legal entities

yaml
id: list_legal_entities
namespace: company.team
tasks:
  - id: list_legal_entities
    type: io.kestra.plugin.deel.org.LegalEntities
    apiToken: "{{ secret('DEEL_API_TOKEN') }}"
    limit: 100
    fetchType: FETCH

List legal entities filtered by country

yaml
id: list_us_entities
namespace: company.team
tasks:
  - id: list_legal_entities
    type: io.kestra.plugin.deel.org.LegalEntities
    apiToken: "{{ secret('DEEL_API_TOKEN') }}"
    country: "US"
    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.

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 country

Filter by country.

Cursor for pagination

Cursor for pagination, as returned by a previous response.

Filter by entity type

Filter by entity type.

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 global payroll flag

Filter by global payroll flag.

Include archived legal entities

Whether to include archived legal entities in the results.

Filter by legal entity ID

Filter by specific legal entity ID.

Default100

Maximum number of legal entities per page

The number of results to return per page. Default is 100.

First legal entity

Available only when fetchType=FETCH_ONE; contains the first legal entity.

SubTypeobject

Fetched legal entities

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

Number of legal entities returned in this response

Number of legal entities included in outputs for the selected fetch type.

Total number of legal entities

Total legal entities reported by the API, regardless of pagination.

Formaturi

Stored legal entities URI

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