Skip to docs navigation

Deel integration guide

Verified

How to connect Deel to WEXTL and use its 1 trigger and 139 actions in your workflows. About Deel: Hire, pay and manage contractors and employees worldwide.

  • 1 trigger
  • 74 searches
  • 65 actions
  • Instant (webhooks)
  • Auth: API key
  • Auth: OAuth

AI-assisted documentation46 min read

This documentation is compiled from our integration source code, internal specs for Deel, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Deel on WEXTL →
  • Deel
  • WEXTL
  • BambooHR
  • CATS
  • actiTIME
  • 7Shifts
  • Connecteam
  • Ashby
  • Affinda
  • Clockify
  • DailyPay
  • Darwinbox
  • Cezanne HR
  • Assembled
  • Bullhorn
  • ClickTime
  • Breathe HR
  • Achievers
  • Base.vn
  • Aladtec
  • Beamery
  • Ceipal
  • BuddyPunch
  • Charlie HR
  • Combo HR
  • Dayforce
  • Calamari
  • ClockIt
  • Breezy HR
  • BrioHR
  • BrightHR
Credential type option 1

Deel - API Token

  • API TokenpasswordRequired

    Create it in Deel under More, Developer, Access Tokens. An organization token reaches the whole organization. A personal token only what you can see. Tick the scopes for the modules you use.[1]

  • Environmentselect

    Sandbox uses api-staging.letsdeel.com and needs its own token.[1]

Credential type option 2

Deel - OAuth 2.0

You’ll be redirected to sign in and approve access. Your password is never shared with WEXTL.

  • Client IDtextRequired

    Create an app under More, Developer, Apps. Choose Organization App for organization data or Personal App for your own. Add the redirect URI shown on this form.[1]

  • Client SecretpasswordRequired
  • Scopesselect

    Select the scopes enabled on your app. A connection idle for 90 days needs to be authorized again.[1]

  1. Log in to your WEXTL account, add the Deel node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Deel account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Events

TriggerInstant trigger firing on each Deel event.
Output fields[3]
FieldType
IDtext
Event Typetext
Event IDtext
Organization IDtext
Timestampdate

Calculate an Employment Cost

SearchEmployer cost estimate for a salary in one country.
Input fields[3]
FieldType
SalaryRequired
number
CountryRequired
choice
CurrencyRequired
choice
Statetext
Benefitstext
Salary Periodchoice
Output fields[3]
FieldType
Costsarray
Nametext
Amounttext
Countrytext
Frequencytext
Country Codetext
Salarytext
Countrytext
Currencytext
Deel Feetext
Frequencytext
Total Coststext
Country Codetext
Benefits Dataarray
Nametext
Plantext
Amounttext
Fee Amounttext

6other output fields

Get a Contract

SearchComplete record for a single contract with optional extras.
Input fields[3]
FieldType
ContractRequired
choice
Expandchoice
Output fields[3]
FieldType
IDtext
Typetext
Quoteobject
Benefitsarray
Currencytext
Titletext
Clientobject
IDtext
Teamobject
Emailtext
Full Nametext
Legal Entityobject
Statustext
Workerobject
IDtext
Emailtext
Countrytext
Full Nametext
Last Nametext
First Nametext
Nationalitytext
Date Of Birthtext
Expected Emailtext
Alternate Emailarray
Divisiontext
Locationtext

25other output fields

Get a Contract Preview

SearchPre-send rendering of a contract document.
Input fields[3]
FieldType
ContractRequired
choice
Template IDtext
Output fields[3]
FieldType
Previewtext

Get a Milestone

SearchDeliverable on a milestone contract in detail.
Input fields[3]
FieldType
ContractRequired
choice
MilestoneRequired
choice
Output fields[3]
FieldType
IDtext
Titletext
Amounttext
Statustext
Created Attext
Descriptiontext
Reported Byobject
IDtext
Full Nametext
Reviewed Byobject
IDtext
Full Nametext
Approval Requestedboolean

Get a Payment Breakdown

SearchItemized view of what a payment contains.
Input fields[3]
FieldType
Payment IDRequired
text
LimitRequired
number
Output fields[3]
FieldType
Datedate
Worktext
Bonustext
Totaltext
Otherstext
Currencytext
Expensestext
Group IDtext
Overtimetext

21other output fields

Get a Payment Statement

SearchStatement paying a group of invoices.
Input fields[3]
FieldType
Payment Statement IDRequired
text
Output fields[3]
FieldType
IDtext
Amounttext
Statustext
Paid Atdate
Invoicesarray
IDtext
Labeltext
Amounttext
Currencytext
Is Auto Addedboolean
Referencetext
Amount Duetext
Created Atdate
Payment Methodtext

4other output fields

Get a Person

SearchProfile of a worker or employee.
Input fields[3]
FieldType
PersonRequired
choice
Include Custom Fieldsboolean
Include Worker Relationsboolean
Output fields[3]
FieldType
IDtext
Statetext
Emailsarray
Typetext
Valuetext
Countrytext
Timezonetext
Addressesarray
Regiontext
Countrytext
Localitytext
Postal Codetext
Street Addresstext
Full Nametext
Job Titletext
Last Nametext

27other output fields

Get a Shift

SearchLogged shift with its type and contract.
Input fields[3]
FieldType
Shift External IDRequired
text
Output fields[3]
FieldType
Metaobject
Endobject
Startobject
Breaksarray
Approval Datetext
Summaryobject
Time Unittext
Time Amountnumber
Total Break Hoursnumber
Payable Break Hoursnumber
Total Payable Hoursnumber
Shift Duration Hoursnumber
Shift Rate External IDtext
Created Atdate
Shift Typetext
Updated Atdate
Contract IDtext
Descriptiontext
External IDtext
Date Of Worktext

2other output fields

Get a Timesheet

SearchLogged hours entry with status and contract.
Input fields[3]
FieldType
TimesheetRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Scaletext
Statustext
Contractobject
IDtext
Typetext
Titletext
Quantitynumber
Worksheetobject
Daysnumber
Hoursnumber
Weeksnumber
Minutesnumber
Attachmentobject
Keytext
Filenametext
Created Attext

10other output fields

Get a Webhook

SearchSubscription details for one webhook.
Input fields[3]
FieldType
WebhookRequired
choice
Output fields[3]
FieldType
IDtext
URLtext
Nametext
Eventsarray
Hiddenboolean
Statustext
Internalboolean
Created Attext
Deleted Attext

5other output fields

Get a Worker Invite Link

SearchSign-up link for a contract worker.
Input fields[3]
FieldType
ContractRequired
choice
Localetext
Output fields[3]
FieldType
Linktext

Get an Adjustment

SearchReads one adjustment with its amount and status.
Input fields[3]
FieldType
AdjustmentRequired
text
Output fields[3]
FieldType
IDtext
Fileobject
IDtext
Nametext
File Typetext
Titletext
Amounttext
Statustext
Odp Onlyboolean
Created Atdate
Updated Atdate
Contract IDtext

8other output fields

Get an EOR Amendment

SearchOne contract change in full detail.
Input fields[3]
FieldType
ContractRequired
choice
Amendment IDRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Itemsarray
IDtext
Itemtext
Typetext
New Valuetext
Data Pointtext
Previous Valuetext
Scopetext
Salarytext
Sourcetext
Currencytext
End Datedate
Holidaysnumber

38other output fields

Get an EOR Offboarding Request

SearchLeaving request attached to a hire.
Input fields[3]
FieldType
ContractRequired
choice
Output fields[3]
FieldType
IDtext
End Datedate
Documentsobject
Supportingarray
Offboardingarray
Created Atdate
Updated Atdate
Contract IDtext
Is Sensitiveboolean
Request Dataobject
Reasontext
End Datedate
Reason Detailtext
Used Time Offobject
Desired End Datedate
Eligible For Rehiretext
Eligible For Rehire Reasontext
Desired End Datedate

Get an Invoice

SearchBilling document with totals and due date.
Input fields[3]
FieldType
Invoice IDRequired
text
Output fields[3]
FieldType
IDtext
Labeltext
Totaltext
Statustext
Paid Atdate
Currencytext
Due Datedate
Issued Atdate
Worker IDtext

4other output fields

Get an Invoice Adjustment

SearchExtra invoice line with its approvers.
Input fields[3]
FieldType
Invoice AdjustmentRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Scaletext
Statustext
Contractobject
IDtext
Typetext
Titletext
Quantitynumber
Approversarray
Emailtext
Approvedboolean
Full Nametext
Worksheetobject
Daysnumber
Hoursnumber
Weeksnumber
Minutesnumber
Attachmentobject
Keytext
Filenametext
Download URLtext

11other output fields

Get an Invoice Download Link

SearchTime-limited link to fetch an invoice file.
Input fields[3]
FieldType
Invoice IDRequired
text
Output fields[3]
FieldType
IDtext
URLtext
Expires Atdate

Get an Organization Structure

SearchHRIS hierarchy with its roles and teams.
Input fields[3]
FieldType
HRIS Org Structure IDRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Typetext
Rolesarray
IDnumber
Nametext
Teamsarray
External IDtext
Teams Countnumber
Enable Rolesboolean
Is Multiselectboolean

Get Custom Field Values for a Contract

SearchEverything held in contract custom fields.
Input fields[3]
FieldType
ContractRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Dataobject
Valuenumber
Texttext
Amountnumber
Currencytext
Optiontext
Optionsarray
Nametext
Typetext

Get Custom Field Values for a Person

SearchValues held in worker profile custom fields.
Input fields[3]
FieldType
WorkerRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Dataobject
Valuenumber
Texttext
Amountnumber
Currencytext
Optiontext
Optionsarray
Nametext
Typetext

Get EOR Contract Details

SearchParticulars of one hire through EOR.
Input fields[3]
FieldType
ContractRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Teamobject
IDtext
Nametext
Salarytext
Statustext
Creatorobject
Nametext
Emailtext
Firstnametext
Currencytext
Employeeobject
Emailtext
Pic URLtext
Last Nametext
First Nametext
Legal Nametext
Nationalitytext
End Datedate

60other output fields

Get EOR Hiring Requirements

SearchHiring rules that apply in one country.
Input fields[3]
FieldType
CountryRequired
choice
Include Usd Valuesboolean
Output fields[3]
FieldType
Salaryobject
Maxtext
Mintext
Max Usdtext
Min Usdtext
Frequencytext
Holidayobject
Maxtext
Mintext
Most Commontext
Currencytext
Probationobject
Maxnumber
Minnumber
Health Insuranceobject
Statustext
Providersarray

Get My Organization

SearchOrganizations reachable with your credential.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext

Get My Profile

SearchProfile belonging to the credential owner.
Output fields[3]
FieldType
IDnumber
Emailtext
User IDnumber
Usernametext
Full Nametext
Last Nametext
Avatar URLtext
First Nametext
Middle Nametext

9other output fields

Get Offboarding Details

SearchExit tracker record for a worker.
Input fields[3]
FieldType
IDRequired
text
Output fields[3]
FieldType
Summaryarray
Dataobject
Nametext
Typetext
Valuetext
Contractobject
IDtext
EORobject
IDtext
Nametext
Timezonetext
Contract Typetext
Progressobject
Statustext
Reference Datetext
Reference Date Typetext
Reference Date Timezonetext
Hiring Typetext
Terminationobject
IDtext
End Datetext
Ending Typetext
Initiated Attext
Initiated Byobject
Public Messagetext
Termination Impactobject
Eligible For Rehiretext
Eligible For Rehire Reasontext
HRIS Profileobject
IDtext
Nametext
Work Emailtext
App Experienceobject
Is Minimal Requirementsboolean

Get Onboarding Details

SearchOnboarding tracker record for a worker.
Input fields[3]
FieldType
Tracker IDRequired
text
Output fields[3]
FieldType
Bannerobject
Keytext
Actiontext
Severitytext
Actionsarray
Datatext
Typetext
Availableboolean
Last Execution Atdate
Bannersarray
Keytext
Actiontext
Severitytext
Profileobject
IDnumber
Nametext
Emailtext
Countrytext
Pic URLtext
Last Logindate
Paid Invoicesarray
Previously Onboardedboolean
Stepperarray
Dataobject
Typetext
Completed Atdate
Summaryarray
Dataobject
Nametext
Typetext
Valuetext
Contractobject
IDtext
IDtext
Nametext
Statustext
Is Pwacboolean
Created Atdate
First Signtext
Completion Datedate
Client Signed Atdate
Employee Agreementobject
Progressobject
Statustext
Sub Statustext
Reference Datedate
Subject To Overdueboolean
Reference Date Timezonetext
Is Action Required From Clientboolean
Checklistobject
Stepsarray
Summaryobject

4other output fields

Get Personal Information

SearchLegal and contact record of a worker.
Input fields[3]
FieldType
WorkerRequired
choice
Output fields[3]
FieldType
IDtext
Kycobject
Is Kyc Approvedboolean
Kyc Approval Datetext
Oooobject
Nametext
End Datetext
Leave Typetext
Start Datedate
Addressesarray
IDtext
Ziptext
Citytext
Typetext
Statetext
Streettext
Countrytext
Worker IDnumber
Work Emailtext
External IDtext
Demographicsobject
Genderobject
Ethnicityobject
Date Of Birthdate

7other output fields

Get Time Off Entitlements

SearchLeave allowance owed to a person.
Input fields[3]
FieldType
PersonRequired
choice
Policy Type Namechoice
Tracking Period Datedate
Output fields[3]
FieldType
Entitlementsarray
IDtext
Usedtext
Eventsarray
Policyobject
Accruedtext
Expiredtext
Approvedtext
Allowancetext
Availabletext
Requestedtext
HRIS Profile IDtext

Get Work Schedule and Holidays

SearchCalendar of holidays, schedules and time off.
Input fields[3]
FieldType
LimitRequired
number
Start Datedate
End Datedate
Peoplechoice
Countrieschoice
Output fields[3]
FieldType
Holidaysarray
Datedate
Nametext
Typetext
Sourcetext
Statesarray
Countrytext
Descriptiontext
Parsed Datedate
Is Mandatoryboolean
Is Every Yearboolean
Work Scheduleobject
Work Weekobject
Hours Per Daynumber
HRIS Profile IDtext
Time Off Dailiesarray
Datedate
Time Off Daily Typetext

List Adjustment Categories

SearchCategories available when filing adjustments.
Input fields[3]
FieldType
LimitRequired
number
Contract Typeschoice
Output fields[3]
FieldType
IDtext
Nametext
Labeltext
Unit Typetext

List Adjustments

SearchAdjustment entries logged on a contract.
Input fields[3]
FieldType
ContractRequired
choice
LimitRequired
number
Fromdate
Todate
Output fields[3]
FieldType
IDtext
Fileobject
IDtext
Nametext
File Typetext
Titletext
Amounttext
Statustext
Odp Onlyboolean
Created Atdate
Updated Atdate
Contract IDtext

7other output fields

List Contract Amendments

SearchChange history of one contract.
Input fields[3]
FieldType
ContractRequired
choice
LimitRequired
number
Statuseschoice
Sign Statuseschoice
Output fields[3]
FieldType
IDtext
Ratenumber
Scaletext
Statustext
Created Atdate
Updated Atdate
Sign Statustext
Contract Nametext
Contract Typetext

3other output fields

List Contract Custom Fields

SearchFields available for tagging contracts.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Typeobject
Nametext
Currencytext
Is Fixedboolean
Optionsarray
Settingsobject
Accessobject
Requiredboolean
Countriesarray
Is Enabledboolean
Worker Typesarray
Placementtext
Created Atdate
Descriptiontext

List Contract Payment Dates

SearchPay cycles and due dates for a contract.
Input fields[3]
FieldType
ContractRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Statustext
Due Datedate

List Contract Templates

SearchReusable templates for drafting contracts.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Titletext

List Contract Termination Reasons

SearchReasons offered when closing contracts.
Input fields[3]
FieldType
LimitRequired
number
Order Bychoice
Orderchoice
Output fields[3]
FieldType
IDtext
Nametext
Frequencytext
Created Atdate
Updated Atdate

List Contracts

SearchContracts with type, status and team filters.
Input fields[3]
FieldType
LimitRequired
number
Order Directionchoice
Typeschoice
Statuseschoice
Teamschoice
Legal Entitieschoice
External IDtext
External ID Absentchoice
Countriesarray

4other input fields

Output fields[3]
FieldType
IDtext
Typetext
Scaletext
Titletext
Clientobject
Teamobject
Legal Entityobject
Statustext
Workerobject
IDtext
Emailtext
Imagetext
Full Nametext
Alternate Emailarray
Created Atdate
Signaturesobject
Client Signed Atdate
Worker Signaturetext
Worker Signed Atdate

11other output fields

List Cost Centers

SearchCost centers belonging to a legal entity.
Input fields[3]
FieldType
Legal EntityRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDnumber
Created Atdate
Updated Atdate
Cost Center Nametext
Cost Center Numbertext

List Countries

SearchCountries with codes, currencies and support flags.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Codetext
Nametext
Statesarray
Codetext
Nametext
State Typetext
EOR Supportboolean
Visa Supportboolean
Default Currencytext

List Deel Invoices

SearchPlatform fee invoices raised by Deel.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Labeltext
Totaltext
Statustext
Currencytext
Created Atdate

List Departments

SearchDepartment hierarchy of your organization.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Parenttext

List EOR Amendments

SearchChange history of one hire.
Input fields[3]
FieldType
ContractRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Typetext
Itemsarray
IDtext
Itemtext
Typetext
New Valuetext
Data Pointtext
Previous Valuetext
Scopetext
Salarytext
Sourcetext
Currencytext
End Datedate
Holidaysnumber

38other output fields

List EOR Contract Documents

SearchPaperwork attached to one hire.
Input fields[3]
FieldType
ContractRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Signaturetext
Signed Atdate
Document Typetext
EOR Signaturetext
EOR Signed Atdate
Client Job Titletext

List Global Payroll Payslips

SearchPayslips issued to one global payroll worker.
Input fields[3]
FieldType
WorkerRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Todate
Fromdate
Statustext

List Groups

SearchGroups with their managers and archive status.
Input fields[3]
FieldType
LimitRequired
number
Sort Orderchoice
Include Archived Groupschoice
External Metadatatext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Managersnumber
Created Atdate
Updated Atdate
Archived Atdate
External Metadatatext

List Invoice Adjustments

SearchInvoice adjustments across all contracts.
Input fields[3]
FieldType
LimitRequired
number
Contract IDchoice
Typeschoice
Statuseschoice
Invoice IDtext
Reporter IDtext
Date Fromdate
Date Todate
Output fields[3]
FieldType
IDtext
Typetext
Scaletext
Statustext
Contractobject
IDtext
Typetext
Titletext
Quantitynumber
Worksheetobject
Daysnumber
Hoursnumber
Weeksnumber
Minutesnumber
Attachmentobject
Keytext
Filenametext
Download URLtext
Created Atdate

10other output fields

List Invoice Adjustments by Contract

SearchInvoice adjustment entries limited to a single contract.
Input fields[3]
FieldType
ContractRequired
choice
LimitRequired
number
Typeschoice
Statuseschoice
Invoice IDtext
Reporter IDtext
Date Fromdate
Date Todate
Output fields[3]
FieldType
IDtext
Typetext
Scaletext
Statustext
Contractobject
IDtext
Typetext
Titletext
Quantitynumber
Worksheetobject
Daysnumber
Hoursnumber
Weeksnumber
Minutesnumber
Attachmentobject
Keytext
Filenametext
Created Atdate

9other output fields

List Invoices

SearchInvoices issued within a date range.
Input fields[3]
FieldType
LimitRequired
number
Issued From Datedate
Issued To Datedate
Statuschoice
Includechoice
Output fields[3]
FieldType
IDtext
Labeltext
Totaltext
Amounttext
Statustext
VAT IDtext
Paid Attext
Currencytext
Deel Feetext

8other output fields

List Job Titles

SearchJob titles Deel recognizes.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDnumber
Nametext

List Legal Entities

SearchLegal entities with address and VAT data.
Input fields[3]
FieldType
LimitRequired
number
Sort Orderchoice
Include Archivedboolean
Legal Entity IDtext
Global Payrollchoice
Typetext
Countrytext
Include Payroll Settingschoice
Output fields[3]
FieldType
IDtext
Nametext
Phonetext
Statustext
VAT IDtext
Addressobject
Ziptext
Citytext
Statetext
Streettext
Countrytext
Countrytext
Created Atdate
Sic Numbertext

6other output fields

List Managers

SearchManagers with contact details.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Emailtext
Last Nametext
First Nametext

List Milestones

SearchDeliverables on a milestone contract.
Input fields[3]
FieldType
ContractRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Titletext
Amounttext
Statustext
Created Attext
Descriptiontext
Reported Byobject
IDtext
Full Nametext
Reviewed Byobject
IDtext
Full Nametext
Approval Requestedboolean

List Off-Cycle Payments

SearchExtra payments paid outside the normal cycle.
Input fields[3]
FieldType
ContractRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Amounttext
Statustext
Created Atdate
Descriptiontext
Reported Byobject
IDtext
Full Nametext
Currency Codetext
Date Submitteddate

List Offboarding Cases

SearchExit tracker cases for leaving workers.
Input fields[3]
FieldType
LimitRequired
number
Searchtext
Hiring Typeschoice
Progress Statuseschoice
Sort Bychoice
Sort Orderchoice
Include Overviewchoice
Ignore Date Rangechoice
Output fields[3]
FieldType
Nametext
Contractobject
IDtext
Progressobject
Statustext
Reference Datetext
Reference Date Typetext
Reference Date Timezonetext
Unique IDtext
Hiring Typetext
HRIS Profileobject
IDtext
App Experienceobject
Is Minimal Requirementsboolean
Termination IDtext
Offboarding Typetext

List Onboarding Employees

SearchWorkers moving through onboarding.
Input fields[3]
FieldType
LimitRequired
number
Searchtext
Contract IDarray
Hiring Typeschoice
Progress Statuseschoice
Countriesarray
Teamsarray
Legal Entitiesarray
HRIS Direct Managersarray

11other input fields

Output fields[3]
FieldType
Nametext
Workerobject
IDtext
Nametext
Job Titletext
Avatar URLtext
Is Entity Contractorboolean
Is Contractor Of Recordboolean
Countryobject
Codetext
Nametext
Profileobject
Pic URLtext
Contractobject
IDtext
EORobject
Is Pwacboolean
Effective Datedate
Global Payrollobject
Offer Letter IDtext
Overviewobject
Bannerobject
Actionsarray
Bannersarray
Profileobject
Stepperarray
Summaryarray
Contractobject
Progressobject
Checklistobject
Contractsarray
Progressobject
Stepsobject
Statustext
Sub Statustext
Waiting Ontext
Reference Datetext
Lifecycle Statustext
People List Statustext
Subject To Overdueboolean
Onboarding Due Datetext
Reference Date Typetext
Contractsarray
Entityobject
Statustext
Is Mainboolean
Is Pwacboolean
Job Titletext
Start Datedate
Tracker IDtext
Worker Typetext
Contract IDtext
Lifecycle Statustext
Unique IDtext

7other output fields

List Organization Structures

SearchHRIS organization structures and their roles.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Typetext
Rolesarray
IDtext
Nametext
Teamsarray
IDtext
Nametext
Parenttext
Childrenarray
Created Atdate
Name Routetext
External IDtext
Editableboolean
Created Atdate
External IDtext
Teams Countnumber

2other output fields

List Payments

SearchPayments within a date span.
Input fields[3]
FieldType
LimitRequired
number
Date Fromdate
Date Todate
Currenciesarray
Entitieschoice
Statuseschoice
Output fields[3]
FieldType
IDtext
Labeltext
Totaltext
Statustext
Paid Atdate
Timezonetext
Total Duetext
Created Atdate
Deel Referencetext

6other output fields

List People

SearchDirectory of workers and employees.
Input fields[3]
FieldType
LimitRequired
number
Searchtext
Teamschoice
Fieldschoice
Sort Bychoice
Sort Orderchoice
Hiring Statuseschoice
Band Placementschoice
Comparative Ratios Fromtext

3other input fields

Output fields[3]
FieldType
IDtext
Statetext
Emailsarray
Typetext
Valuetext
Countrytext
Is Pwacboolean
Timezonetext
Addressesarray
Regiontext
Countrytext
Line Twotext
Localitytext
Postal Codetext
Street Addresstext
Full Nametext
Job Titletext

29other output fields

List Person Custom Fields

SearchCustom fields defined for worker profiles.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Typeobject
Nametext
Currencytext
Is Fixedboolean
Optionsarray
Settingsobject
Accessobject
Requiredboolean
Countriesarray
Is Enabledboolean
Worker Typesarray
Placementtext
Created Atdate
Descriptiontext

List Refund Statements

SearchRefunds issued to your account.
Input fields[3]
FieldType
LimitRequired
number
Date Fromdate
Date Todate
Currenciesarray
Entitieschoice
Output fields[3]
FieldType
IDtext
Labeltext
Amounttext
Statustext
Paid Atdate
Currencytext
Created Atdate
Payment Methodtext

List Roles

SearchRoles tied to an organization structure.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDnumber
Nametext
Scopetext
HRIS Org Structure IDtext

List Shift Rates

SearchPay rates defined for shifts.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Nametext
Typetext
Valuenumber
Created Atdate
Updated Atdate
External IDtext

List Shifts

SearchLogged shifts across contracts.
Input fields[3]
FieldType
LimitRequired
number
From Datedate
To Datedate
Contractschoice
Output fields[3]
FieldType
Metaobject
Endobject
Startobject
Breaksarray
Approval Datetext
Summaryobject
Time Unittext
Time Amountnumber
Total Break Hoursnumber
Payable Break Hoursnumber
Total Payable Hoursnumber
Shift Duration Hoursnumber
Shift Rate External IDtext
Created Atdate
Shift Typetext
Updated Atdate
Contract IDtext
Descriptiontext
External IDtext
Date Of Worktext

2other output fields

List Tasks

SearchClaims for finished contract work.
Input fields[3]
FieldType
ContractRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Amounttext
Statustext
Attachmentobject
Keytext
Filenametext
Descriptiontext
Date Submittedtext

List Teams

SearchTeam directory for your organization.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext

List Time Off Events for a Person

SearchBooked leave events for one worker.
Input fields[3]
FieldType
PersonRequired
choice
LimitRequired
number
Time Off Type IDtext
Policy IDtext
Output fields[3]
FieldType
IDtext
Typetext
Policy IDtext
Created Atdate
Updated Atdate
Event Detailsobject
Birth Datedate
Adoption Datedate
Was Premature Birthboolean
Estimated Birth Datedate
Had Multiple Childrenboolean
Estimated Adoption Datedate
HRIS Profile IDtext
Time Off Type IDtext

List Time Off Policies for a Person

SearchLeave rules that apply to a worker.
Input fields[3]
FieldType
PersonRequired
choice
LimitRequired
number
Policy Type Namechoice
Policy Type IDtext
Output fields[3]
FieldType
IDtext
Nametext
Created Atdate
Leave Typetext
Updated Atdate
Descriptiontext
Policy Typeobject
IDtext
Nametext
Payment Typetext
Custom Fieldsarray
IDtext
Keytext
Nametext
Schemaobject
Field Requirementtext
Requirement Conditionsarray

23other output fields

List Time Off Requests

SearchLeave requests across your whole workforce.
Input fields[3]
FieldType
LimitRequired
number
Statuschoice
Time Off IDsarray
Start Datedate
End Datedate
Approval Start Datedate
Approval End Datedate
Updated Start Datedate
Updated End Datedate

3other input fields

Output fields[3]
FieldType
IDtext
Amounttext
Reasontext
Statustext
Is Paidboolean
End Datedate
Created Atdate
Deleted Atdate
Start Datedate

20other output fields

List Time Off Requests for a Person

SearchRequests for leave filed by a single worker.
Input fields[3]
FieldType
PersonRequired
choice
LimitRequired
number
Statuschoice
Time Off IDsarray
Start Datedate
End Datedate
Approval Start Datedate
Approval End Datedate
Updated Start Datedate

3other input fields

Output fields[3]
FieldType
IDtext
Amounttext
Reasontext
Statustext
Is Paidboolean
End Datedate
Created Atdate
Start Datedate
Updated Atdate

16other output fields

List Timesheets

SearchTimesheet entries for all contracts.
Input fields[3]
FieldType
LimitRequired
number
Contract IDchoice
Statuseschoice
Reporter IDtext
Date Fromdate
Date Todate
Output fields[3]
FieldType
IDtext
Typetext
Scaletext
Statustext
Contractobject
IDtext
Typetext
Titletext
Quantitynumber
Worksheetobject
Daysnumber
Hoursnumber
Weeksnumber
Minutesnumber
Attachmentobject
Keytext
Filenametext
Created Atdate

9other output fields

List Timesheets by Contract

SearchHours logged under a single contract.
Input fields[3]
FieldType
ContractRequired
choice
LimitRequired
number
Statuseschoice
Reporter IDtext
Date Fromdate
Date Todate
Output fields[3]
FieldType
IDtext
Typetext
Scaletext
Statustext
Contractobject
IDtext
Typetext
Titletext
Quantitynumber
Worksheetobject
Daysnumber
Hoursnumber
Weeksnumber
Minutesnumber
Attachmentobject
Keytext
Filenametext
Created Attext

9other output fields

List Webhook Event Types

SearchCatalog of subscribable webhook events.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDnumber
Nametext
Created Attext
Updated Attext
Descriptiontext
Module Nametext
Module Labeltext
Payload Exampletext

List Webhooks

SearchWebhook subscriptions and their state.
Input fields[3]
FieldType
LimitRequired
number
Statuschoice
Hiddenchoice
Searchtext
Ordertext
Includechoice
Output fields[3]
FieldType
IDtext
URLtext
Nametext
Statsobject
Dailyarray
Totalnumber
Failednumber
Succeedednumber
Window Daysnumber
Success Ratenumber
P95 Latency Msnumber
Eventsarray
Hiddenboolean
Statustext
Internalboolean
Created Attext

6other output fields

List Working Locations

SearchWork sites you can assign to people.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDnumber
Nametext

Cancel a Time Off Request

ActionLeave request withdrawn in Deel.
Input fields[3]
FieldType
Time Off Request IDRequired
text
Output fields[3]
FieldType
IDtext
Successboolean

Cancel an EOR Amendment

ActionStops a drafted change on a hire.
Input fields[3]
FieldType
ContractRequired
choice
Amendment IDRequired
text
Output fields[3]
FieldType
Successboolean

Cancel an EOR Contract

ActionCalls off a hire made through employer of record.
Input fields[3]
FieldType
ContractRequired
choice
Cancellation ReasonRequired
choice
Cancellation Messagetext
Output fields[3]
FieldType
IDtext
Successboolean

Clone a Group

ActionCopies a group into a freshly named one.
Input fields[3]
FieldType
GroupRequired
choice
NameRequired
text
External Metadatatext
Output fields[3]
FieldType
IDtext
Nametext
Created Atdate
Updated Atdate
External Metadatatext

Confirm an EOR Amendment

ActionApproval step for a drafted EOR change.
Input fields[3]
FieldType
ContractRequired
choice
Amendment IDRequired
text
Output fields[3]
FieldType
IDtext
Typetext
Itemsarray
IDtext
Itemtext
Typetext
New Valuetext
Data Pointtext
Previous Valuetext
Scopetext
Salarytext
Sourcetext
Currencytext
End Datedate
Holidaysnumber

38other output fields

Create a Contract

ActionContractor paperwork with type, team and entity.
Input fields[3]
FieldType
Contract TitleRequired
text
Contract TypeRequired
choice
TeamRequired
choice
Legal EntityRequired
choice
Documents RequiredRequired
boolean
Main Incomeboolean
Start Datedate
Worker Emailemail
Worker First Nametext

8other input fields

Output fields[3]
FieldType
IDtext
Typetext
Quoteobject
Benefitsarray
Currencytext
Cba Totalnumber
Created Atdate
Updated Atdate
Salary Totalnumber
Annual Salarynumber
Cba Total Usdnumber
Breakdown Costsobject
Salary Total Usdnumber
Titletext
Clientobject
IDtext
Teamobject
Emailtext
Full Nametext
Legal Entityobject
Statustext
Workerobject
IDtext
Emailtext
Imagetext
Countrytext
Full Nametext
Last Nametext
First Nametext
Nationalitytext
Legal Entityobject
Date Of Birthdate
Job Titletext
Seniorityobject
IDnumber
Nametext
Levelnumber

16other output fields

Create a Contract Amendment

ActionProposes revised pay or scope on a running contract.
Input fields[3]
FieldType
ContractRequired
choice
Scalechoice
Amountnumber
Frequencychoice
Currencychoice
Scope Of Worktext
Effective Datedate
Job Titletext
Special Clausetext
Output fields[3]
FieldType
IDtext
Ratenumber
Scaletext
Statustext
Createdboolean
Job Titletext
Worker IDtext
Created Atdate
Updated Atdate

6other output fields

Create a Contract Termination Request

ActionBegins closing a contract, immediately or on a set date.
Input fields[3]
FieldType
ContractRequired
choice
Messagetext
Terminate Nowboolean
Completion Datedate
Termination Typechoice
Eligible For Rehirechoice
Termination Reasonchoice
Eligible For Rehire Reasontext
Output fields[3]
FieldType
IDtext
Completion Datedate

Create a Global Payroll Contract

ActionGlobal payroll worker with address and holiday terms.
Input fields[3]
FieldType
TeamRequired
choice
Legal EntityRequired
choice
First NameRequired
text
Last NameRequired
text
EmailRequired
email
Work EmailRequired
email
StreetRequired
text
CityRequired
text
ZipRequired
text

19other input fields

Output fields[3]
FieldType
IDtext
Typetext
Clientobject
Legal Entityobject
Statustext
Employeeobject
Emailtext
Last Nametext
First Nametext
Employee Numbertext
Job Titletext
Created Atdate
Employmentobject
Typetext
Statetext
Countrytext
End Datedate
Holidaysobject
Start Datedate
Work Visa Requiredboolean
Compensation Detailsobject
Scaletext
Salarynumber
Currencytext

Create a Group

ActionOpens a group, optionally tagged with external metadata.
Input fields[3]
FieldType
NameRequired
text
External Metadatatext
Output fields[3]
FieldType
IDtext
Nametext
Created Atdate
Updated Atdate
External Metadatatext

Create a Manager

ActionAdds a person who manages others.
Input fields[3]
FieldType
EmailRequired
email
Last NameRequired
text
First NameRequired
text
Output fields[3]
FieldType
IDtext
Emailtext
Last Nametext
First Nametext

Create a Milestone

ActionDeliverable with a price on a milestone contract.
Input fields[3]
FieldType
ContractRequired
choice
TitleRequired
text
AmountRequired
text
DescriptionRequired
text
Output fields[3]
FieldType
Createdboolean

Create a Payment Statement

ActionStatement that pays a group of invoices together.
Input fields[3]
FieldType
InvoicesRequired
array
CurrencyRequired
text
Idempotency KeyRequired
text
Payment Methodchoice
Bank Countrychoice
Stablecoin Networkchoice
Output fields[3]
FieldType
IDtext
Amounttext
Statustext
Paid Atdate
Invoicesarray
IDtext
Labeltext
Amounttext
Currencytext
Is Auto Addedboolean
Referencetext
Amount Duetext
Created Atdate
Payment Methodtext

5other output fields

Create a Shift Rate

ActionNamed pay rate for shifts, percentage or flat.
Input fields[3]
FieldType
NameRequired
text
External IDRequired
text
Typechoice
Valuenumber
Output fields[3]
FieldType
Nametext
Typetext
Valuenumber
Created Atdate
Updated Atdate
External IDtext

Create a Task

ActionFinished work claimed against a task-based contract.
Input fields[3]
FieldType
ContractRequired
choice
AmountRequired
text
DescriptionRequired
text
Date SubmittedRequired
date
Group Keytext
Is Auto Approvedboolean
Hourly Report Preset IDtext
Output fields[3]
FieldType
IDtext
Statustext
Createdboolean

Create a Time Off Request

ActionLeave booked for one person across dates.
Input fields[3]
FieldType
End DateRequired
date
Start DateRequired
date
PersonRequired
choice
Reasontext
Statuschoice
Is Paidchoice
Policy IDtext
Descriptiontext
Time Off Type IDtext

1other input field

Output fields[3]
FieldType
Amounttext
Reasontext
Statustext
Is Paidboolean
End Datedate
Created Atdate
Deleted Atdate
Start Datedate
Updated Atdate

20other output fields

Create a Timesheet Entry

ActionWorked hours logged for a contract on a date.
Input fields[3]
FieldType
QuantityRequired
number
Contract IDRequired
choice
DescriptionRequired
text
Date SubmittedRequired
date
Group Keytext
Is Auto Approvedboolean
Hourly Report Preset IDtext
Output fields[3]
FieldType
IDtext
Statustext
Createdboolean
Created Atdate

Create a Webhook

ActionEvent subscription delivering to your URL.
Input fields[3]
FieldType
URLRequired
text
NameRequired
text
EventsRequired
choice
StatusRequired
choice
API VersionRequired
text
Descriptiontext
Signing Keysecret
Include Child Orgsboolean
Output fields[3]
FieldType
IDtext
URLtext
Nametext
Eventsarray
Hiddenboolean
Statustext
Internalboolean
Created Attext
Deleted Attext

4other output fields

Create an Adjustment

ActionAdds a categorized payment adjustment to a contract.
Input fields[3]
FieldType
TitleRequired
text
AmountRequired
text
Contract IDRequired
choice
DescriptionRequired
text
Adjustment Category IDRequired
choice
Vendortext
Countrytext
Odp Onlyboolean
Cycle Referencetext

3other input fields

Output fields[3]
FieldType
IDtext
Fileobject
IDtext
Nametext
File Typetext
Titletext
Amounttext
Statustext
Odp Onlyboolean
Created Atdate
Updated Atdate
Contract IDtext

7other output fields

Create an Employee

ActionDirect employee with salary, country and start date.
Input fields[3]
FieldType
TeamRequired
choice
Legal EntityRequired
choice
EmailRequired
email
First NameRequired
text
Last NameRequired
text
CountryRequired
choice
NationalityRequired
choice
Employment TypeRequired
choice
Start DateRequired
date

13other input fields

Output fields[3]
FieldType
IDtext
Employeeobject
Emailtext
Last Nametext
First Nametext
Work Emailtext
External IDtext
Nationalitytext
Employmentobject
Typetext
Countrytext
End Datedate
Job Titletext
Senioritytext
Start Datedate
Contract IDtext
Part Time Percentagenumber
Compensation Detailsobject
Scaletext
Salarytext
Currencytext

Create an EOR Amendment

ActionDrafts changes to an EOR hire.
Input fields[3]
FieldType
ContractRequired
choice
Scopetext
Customtext
Salarynumber
End Datedate
Holidaysnumber
Job Titletext
Start Datedate
Hourly Ratenumber

15other input fields

Output fields[3]
FieldType
IDtext
Typetext
Itemsarray
IDtext
Itemtext
Typetext
New Valuetext
Data Pointtext
Previous Valuetext
Scopetext
Salarytext
Sourcetext
Currencytext
End Datedate
Holidaysnumber

38other output fields

Create an EOR Contract

ActionEmployer of record hire with role, country and start date.
Input fields[3]
FieldType
TeamRequired
choice
First NameRequired
text
Last NameRequired
text
NationalityRequired
choice
Job TitleRequired
text
SeniorityRequired
choice
Employment CountryRequired
choice
Start DateRequired
date
Scope Of WorkRequired
text

22other input fields

Output fields[3]
FieldType
IDtext
Typetext
Costsobject
Summaryobject
Sectionsarray
Additional Dataobject
Clientobject
Legal Entityobject
Statustext
Employeeobject
Emailtext
Last Nametext
First Nametext
Legal Nametext
Job Codetext
Job Titletext
Seniorityobject
IDnumber
Nametext

5other output fields

Create an Invoice Adjustment

ActionFiles an extra line on a contractor invoice.
Input fields[3]
FieldType
TypeRequired
choice
AmountRequired
number
Contract IDRequired
choice
DescriptionRequired
text
Date SubmittedRequired
date
Recurringboolean
Group Keytext
Is Auto Approvedboolean
Hourly Report Preset IDtext
Output fields[3]
FieldType
IDtext
Statustext
Createdboolean
Created Atdate

Create an Off-Cycle Payment

ActionExtra payment on an irregular schedule.
Input fields[3]
FieldType
ContractRequired
choice
AmountRequired
number
DescriptionRequired
text
Date SubmittedRequired
date
Is Auto Approvedboolean
Payment Due Datedate
Hourly Report Preset IDtext
Output fields[3]
FieldType
IDtext
Createdboolean

Create Shifts

ActionSeveral time tracking entries logged together.
Input fields[3]
FieldType
ShiftsRequired
text
Contract IDRequired
choice
Output fields[3]
FieldType
Metaobject
Endobject
Startobject
Breaksarray
Approval Datetext
Summaryobject
Time Unittext
Time Amountnumber
Total Break Hoursnumber
Payable Break Hoursnumber
Total Payable Hoursnumber
Shift Duration Hoursnumber
Shift Rate External IDtext
Created Atdate
Shift Typetext
Updated Atdate
Contract IDtext
Descriptiontext
External IDtext
Date Of Worktext

2other output fields

Delete a Contract Termination Request

ActionRevokes a pending end-of-contract request.
Input fields[3]
FieldType
ContractRequired
choice
Output fields[3]
FieldType
IDtext
Successboolean

Delete a Custom Field Value from a Contract

ActionEmpties a stored value held on a contract record.
Input fields[3]
FieldType
ContractRequired
choice
Custom FieldRequired
choice
Output fields[3]
FieldType
IDtext
Successboolean

Delete a Custom Field Value from a Person

ActionEmpties one worker profile custom field.
Input fields[3]
FieldType
WorkerRequired
choice
Custom FieldRequired
choice
Output fields[3]
FieldType
IDtext
Successboolean

Delete a Group

ActionArchives a group rather than destroying it.
Input fields[3]
FieldType
GroupRequired
choice
Output fields[3]
FieldType
IDtext
Archived Atdate

Delete a Milestone

ActionDeliverable removal on a milestone contract.
Input fields[3]
FieldType
ContractRequired
choice
MilestoneRequired
choice
Output fields[3]
FieldType
Deletedboolean

Delete a Shift

ActionDeletes one logged shift by reference.
Input fields[3]
FieldType
Shift External IDRequired
text
Output fields[3]
FieldType
IDtext
Successboolean

Delete a Shift Rate

ActionShift pay rate removal by external ID.
Input fields[3]
FieldType
Shift Rate External IDRequired
text
Output fields[3]
FieldType
IDtext
Successboolean

Delete a Task

ActionWithdraws a reported piece of contract work.
Input fields[3]
FieldType
ContractRequired
choice
TaskRequired
choice
Reasontext
Output fields[3]
FieldType
Deletedboolean

Delete a Timesheet Entry

ActionDeletes logged worked hours.
Input fields[3]
FieldType
TimesheetRequired
text
Reasontext
Output fields[3]
FieldType
Deletedboolean

Delete a Webhook

ActionUnsubscribes a URL from event deliveries.
Input fields[3]
FieldType
WebhookRequired
choice
Output fields[3]
FieldType
Deletedboolean

Delete an Adjustment

ActionRemoves one contract adjustment entry.
Input fields[3]
FieldType
AdjustmentRequired
text
Output fields[3]
FieldType
Deletedboolean

Delete an Invoice Adjustment

ActionRemoves an extra line of a contractor invoice.
Input fields[3]
FieldType
Invoice AdjustmentRequired
text
Output fields[3]
FieldType
Deletedboolean

Delete Multiple Shifts

ActionBulk shift deletion by external identifiers.
Input fields[3]
FieldType
External IDsRequired
array
Output fields[3]
FieldType
Messagetext

Make an API Call

universalYour own Deel REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Keytext
Valuetext
Status codenumber

Remove a Contract Invitation

ActionInvalidates an invite already delivered.
Input fields[3]
FieldType
ContractRequired
choice
Output fields[3]
FieldType
Deletedboolean

Request an EOR Termination

ActionStarts an exit for a hired employee.
Input fields[3]
FieldType
ContractRequired
choice
ReasonRequired
choice
Reason DetailRequired
text
Used Time OffRequired
text
Is Employee NotifiedRequired
boolean
Attachmentstext
Is Sensitiveboolean
Severance Typechoice
Desired End Datedate

8other input fields

Output fields[3]
FieldType
IDtext
End Datedate
Documentsobject
Supportingarray
Offboardingarray
Created Atdate
Updated Atdate
Contract IDtext
Is Sensitiveboolean
Request Dataobject
Reasontext
End Datedate
Reason Detailtext
Used Time Offobject
Desired End Datedate
Eligible For Rehiretext
Eligible For Rehire Reasontext
Desired End Datedate

Review a Task

ActionSingle decision on contract work.
Input fields[3]
FieldType
ContractRequired
choice
TaskRequired
choice
StatusRequired
choice
Reasontext
Output fields[3]
FieldType
Createdboolean

Review a Timesheet

ActionVerdict on one logged hours entry.
Input fields[3]
FieldType
TimesheetRequired
text
StatusRequired
choice
Reasontext
Output fields[3]
FieldType
Createdboolean

Review an Invoice Adjustment

ActionDecision on an extra invoice line.
Input fields[3]
FieldType
Invoice AdjustmentRequired
text
StatusRequired
choice
Reasontext
Output fields[3]
FieldType
Createdboolean

Review Multiple Tasks

ActionBulk decision on reported contract tasks.
Input fields[3]
FieldType
ContractRequired
choice
IDsRequired
array
StatusRequired
choice
Reasontext
Output fields[3]
FieldType
Createdboolean

Review Multiple Timesheets

ActionBulk decision on logged hours.
Input fields[3]
FieldType
IDsRequired
array
StatusRequired
choice
Reasontext
Output fields[3]
FieldType
Createdboolean

Review Time Off Requests

ActionBulk decisions on leave requests.
Input fields[3]
FieldType
ReviewsRequired
array
Time Off Request IDRequired
text
DecisionRequired
choice
Output fields[3]
FieldType
Reviewedarray
IDtext
Statustext
Not Reviewedarray
IDtext
Errortext

Send a Contract to a Worker

ActionInvitation delivering a contract for signing.
Input fields[3]
FieldType
ContractRequired
choice
Emailemail
Localechoice
Messagetext
Output fields[3]
FieldType
Createdboolean

Set a Custom Field Value for a Contract

ActionFills in one contract attribute you defined.
Input fields[3]
FieldType
ContractRequired
choice
Custom FieldRequired
choice
DataRequired
text
Output fields[3]
FieldType
IDtext
Successboolean

Set a Custom Field Value for a Person

ActionSaves a value for a worker attribute.
Input fields[3]
FieldType
WorkerRequired
choice
Custom FieldRequired
choice
DataRequired
text
Output fields[3]
FieldType
IDtext
Successboolean

Sign a Contract

ActionClient countersignature for a contract.
Input fields[3]
FieldType
ContractRequired
choice
Client SignatureRequired
text
Contract Template IDnumber
Output fields[3]
FieldType
Createdboolean

Update a Contract External ID

ActionAttaches your own reference to a contract.
Input fields[3]
FieldType
ContractRequired
choice
External IDtext
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
Typetext
Quoteobject
Benefitsarray
Currencytext
Titletext
Clientobject
IDtext
Teamobject
Emailtext
Full Nametext
Legal Entityobject
Statustext
Workerobject
IDtext
Emailtext
Countrytext
Full Nametext
Last Nametext
First Nametext
Nationalitytext
Date Of Birthtext
Expected Emailtext
Alternate Emailarray
Job Titletext
Seniorityobject
IDnumber
Nametext
Levelnumber

20other output fields

Update a Department

ActionReassigns a worker to a department.
Input fields[3]
FieldType
PersonRequired
choice
DepartmentRequired
choice
Replace Other Positionschoice
Effective Datedate
Output fields[3]
FieldType
Updatedboolean

Update a Group

ActionGives a group a different title.
Input fields[3]
FieldType
GroupRequired
choice
NameRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Created Atdate
Updated Atdate
External Metadatatext

Update a Shift

ActionRevises a logged worked shift.
Input fields[3]
FieldType
Shift External IDRequired
text
Summarytext
Descriptiontext
Date Of Workdate
Payroll Cycle Reftext
Clear Fieldschoice
Output fields[3]
FieldType
Metaobject
Endobject
Startobject
Breaksarray
Approval Datetext
Summaryobject
Time Unittext
Time Amountnumber
Total Break Hoursnumber
Payable Break Hoursnumber
Total Payable Hoursnumber
Shift Duration Hoursnumber
Shift Rate External IDtext
Created Atdate
Shift Typetext
Updated Atdate
Contract IDtext
Descriptiontext
External IDtext
Date Of Worktext

2other output fields

Update a Shift Rate

ActionRevises a pay rate for shifts.
Input fields[3]
FieldType
Shift Rate External IDRequired
text
Nametext
Typechoice
Valuenumber
Output fields[3]
FieldType
Nametext
Typetext
Valuenumber
Created Atdate
Updated Atdate
External IDtext

Update a Task

ActionRevises a task reported on a contract.
Input fields[3]
FieldType
Task IDRequired
text
Amounttext
Descriptiontext
Hourly Report Preset IDtext
Clear Fieldschoice
Output fields[3]
FieldType
Created Atdate
Updated Atdate

Update a Time Off Request

ActionReschedules leave already requested.
Input fields[3]
FieldType
Time Off Request IDRequired
text
End DateRequired
date
Start DateRequired
date
PersonRequired
choice
Reasontext
Is Paidchoice
Policy IDtext
Descriptiontext
Time Off Type IDtext
Output fields[3]
FieldType
Amounttext
Reasontext
Statustext
Is Paidboolean
End Datedate
Created Atdate
Deleted Atdate
Start Datedate
Updated Atdate

20other output fields

Update a Timesheet Entry

ActionCorrects hours logged on a timesheet.
Input fields[3]
FieldType
TimesheetRequired
text
QuantityRequired
number
DescriptionRequired
text
Hourly Report Preset IDtext
Output fields[3]
FieldType
Updatedboolean

Update a Webhook

ActionReconfigures an existing webhook subscription.
Input fields[3]
FieldType
WebhookRequired
choice
URLtext
Nametext
Replace Eventschoice
Statuschoice
Descriptiontext
Include Child Orgschoice
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
URLtext
Nametext
Eventsarray
Hiddenboolean
Statustext
Internalboolean
Created Attext
Deleted Attext

4other output fields

Update a Working Location

ActionAssigns a worker to another work site.
Input fields[3]
FieldType
PersonRequired
choice
Working LocationRequired
choice
Output fields[3]
FieldType
Updatedboolean

Update an Adjustment

ActionRevises fields of a contract adjustment.
Input fields[3]
FieldType
AdjustmentRequired
text
Filetext
Titletext
Amounttext
Countrytext
Odp Onlychoice
Descriptiontext
Vendor Nametext
Date Of Adjustmentdate

2other input fields

Output fields[3]
FieldType
Updatedboolean

Update an Invoice Adjustment

ActionRewrites details of an invoice adjustment.
Input fields[3]
FieldType
Invoice AdjustmentRequired
text
Titletext
Amountnumber
Descriptiontext
Output fields[3]
FieldType
Updatedboolean

Update Personal Information

ActionEdits the personal record of a worker.
Input fields[3]
FieldType
WorkerRequired
choice
Work Emailemail
Date Of Birthdate
Phone Numberstext
Personal Emailemail
Preferred Nametext
Legal Last Nametext
Legal First Nametext
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
Successboolean

Validate a Time Off Request

ActionDry run that checks a leave request.
Input fields[3]
FieldType
End DateRequired
date
Start DateRequired
date
PersonRequired
choice
Is Paidchoice
Policy IDtext
Descriptiontext
Time Off Type IDtext
Output fields[3]
FieldType
Datesarray
Datedate
Typetext
Hoursarray
Amounttext
Day Typesarray
Holiday Nametext
Time Off Percentagetext
Amounttext
Is Validboolean
New End Datedate
Custom Fieldsarray
IDtext
Keytext
Nametext
Schemaobject
Field Requirementtext
Requirement Conditionsarray
Is Event Basedboolean
New Start Datedate
Remaining Balancetext
Require Attachmentboolean

9other output fields

Look for Deel templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Deel Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Deel.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 14, 2026 14:55

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.