Deel People PeopleList
CertifiedList People
Deel People PeopleList
List People
List people in the organization with their employment details. Supports offset-based pagination.
type: io.kestra.plugin.deel.people.PeopleListExamples
List all people
id: list_people
namespace: company.team
tasks:
- id: list_people
type: io.kestra.plugin.deel.people.PeopleList
apiToken: "{{ secret('DEEL_API_TOKEN') }}"
limit: 50
fetchType: FETCH
List active people with search
id: list_active_people
namespace: company.team
tasks:
- id: list_people
type: io.kestra.plugin.deel.people.PeopleList
apiToken: "{{ secret('DEEL_API_TOKEN') }}"
hiringStatus: "active"
search: "John"
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
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.
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.
hiringStatus string
Filter by hiring status
Filter people by hiring status (e.g., active, onboarding, offboarding, inactive).
hiringType string
Filter by hiring type
Filter people by hiring type (e.g., employee, contractor, eor).
legalEntityId string
Filter by legal entity ID
Filter people by legal entity ID.
limit integerstring
25Maximum number of people per page
Number of people to return per page (max 100). Default is 25.
offset integerstring
0Offset for pagination
Index of the first record to return. Default is 0.
search string
Search term
Search people by name, email, or other fields.
updatedSince string
Filter by updated since
Filter people updated since the given timestamp (ISO 8601 format).
Outputs
row object
First person
Available only when fetchType=FETCH_ONE; contains the first person.
rows array
Fetched people
Available only when fetchType=FETCH; contains people for the current response page.
size integer
Number of people returned in this response
Number of people included in outputs for the selected fetch type.
total integer
Total number of people
Total people reported by the API, regardless of pagination.
uri string
uriStored people URI
Available only when fetchType=STORE; Kestra internal storage path to the Ion file.
