Deel Timesheets List

Deel Timesheets List

Certified

List Timesheets

List timesheets in the account. Requires the timesheets: read scope. Supports offset-based pagination.

yaml
type: io.kestra.plugin.deel.timesheets.List

List timesheets

yaml
id: list_timesheets
namespace: company.team
tasks:
  - id: list_timesheets
    type: io.kestra.plugin.deel.timesheets.List
    apiToken: "{{ secret('DEEL_API_TOKEN') }}"
    limit: 25
    fetchType: FETCH

List approved timesheets for a contract in a date range

yaml
id: list_contract_timesheets
namespace: company.team
tasks:
  - id: list_timesheets
    type: io.kestra.plugin.deel.timesheets.List
    apiToken: "{{ secret('DEEL_API_TOKEN') }}"
    contractId: "contract_abc123"
    status: "approved"
    dateFrom: "2024-01-01"
    dateTo: "2024-12-31"
    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 contract ID

Filter results to timesheets belonging to this Deel contract ID.

Filter by submission start date

Filter results to timesheets submitted on or after this date (YYYY-MM-DD).

Filter by submission end date

Filter results to timesheets submitted before this date (YYYY-MM-DD).

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.

Default25

Maximum number of timesheets per page

Maximum number of records to return per page.

Default0

Offset for pagination

Number of records to skip before starting to return results. Default is 0.

Filter by status

Filter results to timesheets with the specified status (approved, declined, not_payable, paid, pending, processing).

First timesheet

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

SubTypeobject

Fetched timesheets

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

Number of timesheets returned in this response

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

Total number of timesheets

Total timesheets reported by the API, regardless of pagination.

Formaturi

Stored timesheets URI

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