Deel

HR API key

Read and manage contracts, workers, invoices and payroll data in Deel from any Windmill script, flow or app.

Set up in 3 steps

Create an API key

In Deel, open Settings then Developer, and create an API token, granting only the scopes your scripts need.

Add the resource in Windmill

Open Resources, add a resource of type deel, and paste the key.

Run your first script

Fork any script below and read before writing anything. There are hundreds here, so search by the verb you need.

Scripts

Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.

Resource type

deel — the shape of the credential every script on this page expects.

View raw schema →

Field	Type	Required	What it is
apiKey	string	Yes	API key

Questions

This reads payroll and identity data

It does. Scope the key to what a script actually needs, and keep the resource in a folder only the right people can read.

Sandbox or production?

Deel issues keys per environment and they do not cross. Keep a resource for each and switch the one a flow points at.

Is my key stored on the hub?

Never. It lives only in your own Windmill workspace, encrypted at rest.

Set up in 3 steps

Create an API key

Add the resource in Windmill

Run your first script

Scripts

View information about amendment

Validate time-off request

Validate amendment data points

Upload required immigration document

Upload employee compliance document

Upload a required immigration document

Upload Vendor Bill Attachment

Update working location

Update time-off request

Update raw shift

Update personal information by external id

Update personal information

Update organization structure

Update organization custom role

Update employee information

Update custom field value

Update compensation

Update auto withdraw setting for contractor

Update an invoice adjustment

Update an existing HRIS Org Structure by external ID

Update an existing HRIS Org Structure

Update an adjustment

Update address

Update additional information

Update a worker relation type by external id

Update a worker relation type

Update a timesheet entry

Update a specific EOR contract amendment

Update a shift rate

Update a shift

Resource type

Questions