Deel integration guide
VerifiedHow 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].
Requirements
Get your Deel credentials
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]
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]
Connect Deel in WEXTL
- 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.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Deel account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Deel triggers and actions on WEXTL
The list below is a reference of every Deel node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every Deel node module below. Each one opens to show its input parameters, outputs, and connection requirements.
Watch Events
TriggerInstant trigger firing on each Deel event.
| Field | Type |
|---|---|
| ID | text |
| Event Type | text |
| Event ID | text |
| Organization ID | text |
| Timestamp | date |
Calculate an Employment Cost
SearchEmployer cost estimate for a salary in one country.
| Field | Type |
|---|---|
SalaryRequired | number |
CountryRequired | choice |
CurrencyRequired | choice |
| State | text |
| Benefits | text |
| Salary Period | choice |
| Field | Type |
|---|---|
| Costs | array |
| Name | text |
| Amount | text |
| Country | text |
| Frequency | text |
| Country Code | text |
| Salary | text |
| Country | text |
| Currency | text |
| Deel Fee | text |
| Frequency | text |
| Total Costs | text |
| Country Code | text |
| Benefits Data | array |
| Name | text |
| Plan | text |
| Amount | text |
| Fee Amount | text |
6other output fields
Get a Contract
SearchComplete record for a single contract with optional extras.
| Field | Type |
|---|---|
ContractRequired | choice |
| Expand | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Quote | object |
| Benefits | array |
| Currency | text |
| Title | text |
| Client | object |
| ID | text |
| Team | object |
| text | |
| Full Name | text |
| Legal Entity | object |
| Status | text |
| Worker | object |
| ID | text |
| text | |
| Country | text |
| Full Name | text |
| Last Name | text |
| First Name | text |
| Nationality | text |
| Date Of Birth | text |
| Expected Email | text |
| Alternate Email | array |
| Division | text |
| Location | text |
25other output fields
Get a Contract Preview
SearchPre-send rendering of a contract document.
| Field | Type |
|---|---|
ContractRequired | choice |
| Template ID | text |
| Field | Type |
|---|---|
| Preview | text |
Get a Milestone
SearchDeliverable on a milestone contract in detail.
| Field | Type |
|---|---|
ContractRequired | choice |
MilestoneRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Title | text |
| Amount | text |
| Status | text |
| Created At | text |
| Description | text |
| Reported By | object |
| ID | text |
| Full Name | text |
| Reviewed By | object |
| ID | text |
| Full Name | text |
| Approval Requested | boolean |
Get a Payment Breakdown
SearchItemized view of what a payment contains.
| Field | Type |
|---|---|
Payment IDRequired | text |
LimitRequired | number |
| Field | Type |
|---|---|
| Date | date |
| Work | text |
| Bonus | text |
| Total | text |
| Others | text |
| Currency | text |
| Expenses | text |
| Group ID | text |
| Overtime | text |
21other output fields
Get a Payment Statement
SearchStatement paying a group of invoices.
| Field | Type |
|---|---|
Payment Statement IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Amount | text |
| Status | text |
| Paid At | date |
| Invoices | array |
| ID | text |
| Label | text |
| Amount | text |
| Currency | text |
| Is Auto Added | boolean |
| Reference | text |
| Amount Due | text |
| Created At | date |
| Payment Method | text |
4other output fields
Get a Person
SearchProfile of a worker or employee.
| Field | Type |
|---|---|
PersonRequired | choice |
| Include Custom Fields | boolean |
| Include Worker Relations | boolean |
| Field | Type |
|---|---|
| ID | text |
| State | text |
| Emails | array |
| Type | text |
| Value | text |
| Country | text |
| Timezone | text |
| Addresses | array |
| Region | text |
| Country | text |
| Locality | text |
| Postal Code | text |
| Street Address | text |
| Full Name | text |
| Job Title | text |
| Last Name | text |
27other output fields
Get a Shift
SearchLogged shift with its type and contract.
| Field | Type |
|---|---|
Shift External IDRequired | text |
| Field | Type |
|---|---|
| Meta | object |
| End | object |
| Start | object |
| Breaks | array |
| Approval Date | text |
| Summary | object |
| Time Unit | text |
| Time Amount | number |
| Total Break Hours | number |
| Payable Break Hours | number |
| Total Payable Hours | number |
| Shift Duration Hours | number |
| Shift Rate External ID | text |
| Created At | date |
| Shift Type | text |
| Updated At | date |
| Contract ID | text |
| Description | text |
| External ID | text |
| Date Of Work | text |
2other output fields
Get a Timesheet
SearchLogged hours entry with status and contract.
| Field | Type |
|---|---|
TimesheetRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Scale | text |
| Status | text |
| Contract | object |
| ID | text |
| Type | text |
| Title | text |
| Quantity | number |
| Worksheet | object |
| Days | number |
| Hours | number |
| Weeks | number |
| Minutes | number |
| Attachment | object |
| Key | text |
| Filename | text |
| Created At | text |
10other output fields
Get a Webhook
SearchSubscription details for one webhook.
| Field | Type |
|---|---|
WebhookRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Name | text |
| Events | array |
| Hidden | boolean |
| Status | text |
| Internal | boolean |
| Created At | text |
| Deleted At | text |
5other output fields
Get a Worker Invite Link
SearchSign-up link for a contract worker.
| Field | Type |
|---|---|
ContractRequired | choice |
| Locale | text |
| Field | Type |
|---|---|
| Link | text |
Get an Adjustment
SearchReads one adjustment with its amount and status.
| Field | Type |
|---|---|
AdjustmentRequired | text |
| Field | Type |
|---|---|
| ID | text |
| File | object |
| ID | text |
| Name | text |
| File Type | text |
| Title | text |
| Amount | text |
| Status | text |
| Odp Only | boolean |
| Created At | date |
| Updated At | date |
| Contract ID | text |
8other output fields
Get an EOR Amendment
SearchOne contract change in full detail.
| Field | Type |
|---|---|
ContractRequired | choice |
Amendment IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Items | array |
| ID | text |
| Item | text |
| Type | text |
| New Value | text |
| Data Point | text |
| Previous Value | text |
| Scope | text |
| Salary | text |
| Source | text |
| Currency | text |
| End Date | date |
| Holidays | number |
38other output fields
Get an EOR Offboarding Request
SearchLeaving request attached to a hire.
| Field | Type |
|---|---|
ContractRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| End Date | date |
| Documents | object |
| Supporting | array |
| Offboarding | array |
| Created At | date |
| Updated At | date |
| Contract ID | text |
| Is Sensitive | boolean |
| Request Data | object |
| Reason | text |
| End Date | date |
| Reason Detail | text |
| Used Time Off | object |
| Desired End Date | date |
| Eligible For Rehire | text |
| Eligible For Rehire Reason | text |
| Desired End Date | date |
Get an Invoice
SearchBilling document with totals and due date.
| Field | Type |
|---|---|
Invoice IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Label | text |
| Total | text |
| Status | text |
| Paid At | date |
| Currency | text |
| Due Date | date |
| Issued At | date |
| Worker ID | text |
4other output fields
Get an Invoice Adjustment
SearchExtra invoice line with its approvers.
| Field | Type |
|---|---|
Invoice AdjustmentRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Scale | text |
| Status | text |
| Contract | object |
| ID | text |
| Type | text |
| Title | text |
| Quantity | number |
| Approvers | array |
| text | |
| Approved | boolean |
| Full Name | text |
| Worksheet | object |
| Days | number |
| Hours | number |
| Weeks | number |
| Minutes | number |
| Attachment | object |
| Key | text |
| Filename | text |
| Download URL | text |
11other output fields
Get an Invoice Download Link
SearchTime-limited link to fetch an invoice file.
| Field | Type |
|---|---|
Invoice IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Expires At | date |
Get an Organization Structure
SearchHRIS hierarchy with its roles and teams.
| Field | Type |
|---|---|
HRIS Org Structure IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Type | text |
| Roles | array |
| ID | number |
| Name | text |
| Teams | array |
| External ID | text |
| Teams Count | number |
| Enable Roles | boolean |
| Is Multiselect | boolean |
Get Custom Field Values for a Contract
SearchEverything held in contract custom fields.
| Field | Type |
|---|---|
ContractRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Data | object |
| Value | number |
| Text | text |
| Amount | number |
| Currency | text |
| Option | text |
| Options | array |
| Name | text |
| Type | text |
Get Custom Field Values for a Person
SearchValues held in worker profile custom fields.
| Field | Type |
|---|---|
WorkerRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Data | object |
| Value | number |
| Text | text |
| Amount | number |
| Currency | text |
| Option | text |
| Options | array |
| Name | text |
| Type | text |
Get EOR Contract Details
SearchParticulars of one hire through EOR.
| Field | Type |
|---|---|
ContractRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Team | object |
| ID | text |
| Name | text |
| Salary | text |
| Status | text |
| Creator | object |
| Name | text |
| text | |
| Firstname | text |
| Currency | text |
| Employee | object |
| text | |
| Pic URL | text |
| Last Name | text |
| First Name | text |
| Legal Name | text |
| Nationality | text |
| End Date | date |
60other output fields
Get EOR Hiring Requirements
SearchHiring rules that apply in one country.
| Field | Type |
|---|---|
CountryRequired | choice |
| Include Usd Values | boolean |
| Field | Type |
|---|---|
| Salary | object |
| Max | text |
| Min | text |
| Max Usd | text |
| Min Usd | text |
| Frequency | text |
| Holiday | object |
| Max | text |
| Min | text |
| Most Common | text |
| Currency | text |
| Probation | object |
| Max | number |
| Min | number |
| Health Insurance | object |
| Status | text |
| Providers | array |
Get My Organization
SearchOrganizations reachable with your credential.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
Get My Profile
SearchProfile belonging to the credential owner.
| Field | Type |
|---|---|
| ID | number |
| text | |
| User ID | number |
| Username | text |
| Full Name | text |
| Last Name | text |
| Avatar URL | text |
| First Name | text |
| Middle Name | text |
9other output fields
Get Offboarding Details
SearchExit tracker record for a worker.
| Field | Type |
|---|---|
IDRequired | text |
| Field | Type |
|---|---|
| Summary | array |
| Data | object |
| Name | text |
| Type | text |
| Value | text |
| Contract | object |
| ID | text |
| EOR | object |
| ID | text |
| Name | text |
| Timezone | text |
| Contract Type | text |
| Progress | object |
| Status | text |
| Reference Date | text |
| Reference Date Type | text |
| Reference Date Timezone | text |
| Hiring Type | text |
| Termination | object |
| ID | text |
| End Date | text |
| Ending Type | text |
| Initiated At | text |
| Initiated By | object |
| Public Message | text |
| Termination Impact | object |
| Eligible For Rehire | text |
| Eligible For Rehire Reason | text |
| HRIS Profile | object |
| ID | text |
| Name | text |
| Work Email | text |
| App Experience | object |
| Is Minimal Requirements | boolean |
Get Onboarding Details
SearchOnboarding tracker record for a worker.
| Field | Type |
|---|---|
Tracker IDRequired | text |
| Field | Type |
|---|---|
| Banner | object |
| Key | text |
| Action | text |
| Severity | text |
| Actions | array |
| Data | text |
| Type | text |
| Available | boolean |
| Last Execution At | date |
| Banners | array |
| Key | text |
| Action | text |
| Severity | text |
| Profile | object |
| ID | number |
| Name | text |
| text | |
| Country | text |
| Pic URL | text |
| Last Login | date |
| Paid Invoices | array |
| Previously Onboarded | boolean |
| Stepper | array |
| Data | object |
| Type | text |
| Completed At | date |
| Summary | array |
| Data | object |
| Name | text |
| Type | text |
| Value | text |
| Contract | object |
| ID | text |
| ID | text |
| Name | text |
| Status | text |
| Is Pwac | boolean |
| Created At | date |
| First Sign | text |
| Completion Date | date |
| Client Signed At | date |
| Employee Agreement | object |
| Progress | object |
| Status | text |
| Sub Status | text |
| Reference Date | date |
| Subject To Overdue | boolean |
| Reference Date Timezone | text |
| Is Action Required From Client | boolean |
| Checklist | object |
| Steps | array |
| Summary | object |
4other output fields
Get Personal Information
SearchLegal and contact record of a worker.
| Field | Type |
|---|---|
WorkerRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Kyc | object |
| Is Kyc Approved | boolean |
| Kyc Approval Date | text |
| Ooo | object |
| Name | text |
| End Date | text |
| Leave Type | text |
| Start Date | date |
| Addresses | array |
| ID | text |
| Zip | text |
| City | text |
| Type | text |
| State | text |
| Street | text |
| Country | text |
| Worker ID | number |
| Work Email | text |
| External ID | text |
| Demographics | object |
| Gender | object |
| Ethnicity | object |
| Date Of Birth | date |
7other output fields
Get Time Off Entitlements
SearchLeave allowance owed to a person.
| Field | Type |
|---|---|
PersonRequired | choice |
| Policy Type Name | choice |
| Tracking Period Date | date |
| Field | Type |
|---|---|
| Entitlements | array |
| ID | text |
| Used | text |
| Events | array |
| Policy | object |
| Accrued | text |
| Expired | text |
| Approved | text |
| Allowance | text |
| Available | text |
| Requested | text |
| HRIS Profile ID | text |
Get Work Schedule and Holidays
SearchCalendar of holidays, schedules and time off.
| Field | Type |
|---|---|
LimitRequired | number |
| Start Date | date |
| End Date | date |
| People | choice |
| Countries | choice |
| Field | Type |
|---|---|
| Holidays | array |
| Date | date |
| Name | text |
| Type | text |
| Source | text |
| States | array |
| Country | text |
| Description | text |
| Parsed Date | date |
| Is Mandatory | boolean |
| Is Every Year | boolean |
| Work Schedule | object |
| Work Week | object |
| Hours Per Day | number |
| HRIS Profile ID | text |
| Time Off Dailies | array |
| Date | date |
| Time Off Daily Type | text |
List Adjustment Categories
SearchCategories available when filing adjustments.
| Field | Type |
|---|---|
LimitRequired | number |
| Contract Types | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Label | text |
| Unit Type | text |
List Adjustments
SearchAdjustment entries logged on a contract.
| Field | Type |
|---|---|
ContractRequired | choice |
LimitRequired | number |
| From | date |
| To | date |
| Field | Type |
|---|---|
| ID | text |
| File | object |
| ID | text |
| Name | text |
| File Type | text |
| Title | text |
| Amount | text |
| Status | text |
| Odp Only | boolean |
| Created At | date |
| Updated At | date |
| Contract ID | text |
7other output fields
List Contract Amendments
SearchChange history of one contract.
| Field | Type |
|---|---|
ContractRequired | choice |
LimitRequired | number |
| Statuses | choice |
| Sign Statuses | choice |
| Field | Type |
|---|---|
| ID | text |
| Rate | number |
| Scale | text |
| Status | text |
| Created At | date |
| Updated At | date |
| Sign Status | text |
| Contract Name | text |
| Contract Type | text |
3other output fields
List Contract Custom Fields
SearchFields available for tagging contracts.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Type | object |
| Name | text |
| Currency | text |
| Is Fixed | boolean |
| Options | array |
| Settings | object |
| Access | object |
| Required | boolean |
| Countries | array |
| Is Enabled | boolean |
| Worker Types | array |
| Placement | text |
| Created At | date |
| Description | text |
List Contract Payment Dates
SearchPay cycles and due dates for a contract.
| Field | Type |
|---|---|
ContractRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Due Date | date |
List Contract Templates
SearchReusable templates for drafting contracts.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Title | text |
List Contract Termination Reasons
SearchReasons offered when closing contracts.
| Field | Type |
|---|---|
LimitRequired | number |
| Order By | choice |
| Order | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Frequency | text |
| Created At | date |
| Updated At | date |
List Contracts
SearchContracts with type, status and team filters.
| Field | Type |
|---|---|
LimitRequired | number |
| Order Direction | choice |
| Types | choice |
| Statuses | choice |
| Teams | choice |
| Legal Entities | choice |
| External ID | text |
| External ID Absent | choice |
| Countries | array |
4other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Scale | text |
| Title | text |
| Client | object |
| Team | object |
| Legal Entity | object |
| Status | text |
| Worker | object |
| ID | text |
| text | |
| Image | text |
| Full Name | text |
| Alternate Email | array |
| Created At | date |
| Signatures | object |
| Client Signed At | date |
| Worker Signature | text |
| Worker Signed At | date |
11other output fields
List Cost Centers
SearchCost centers belonging to a legal entity.
| Field | Type |
|---|---|
Legal EntityRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | number |
| Created At | date |
| Updated At | date |
| Cost Center Name | text |
| Cost Center Number | text |
List Countries
SearchCountries with codes, currencies and support flags.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Code | text |
| Name | text |
| States | array |
| Code | text |
| Name | text |
| State Type | text |
| EOR Support | boolean |
| Visa Support | boolean |
| Default Currency | text |
List Deel Invoices
SearchPlatform fee invoices raised by Deel.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Label | text |
| Total | text |
| Status | text |
| Currency | text |
| Created At | date |
List Departments
SearchDepartment hierarchy of your organization.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Parent | text |
List EOR Amendments
SearchChange history of one hire.
| Field | Type |
|---|---|
ContractRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Items | array |
| ID | text |
| Item | text |
| Type | text |
| New Value | text |
| Data Point | text |
| Previous Value | text |
| Scope | text |
| Salary | text |
| Source | text |
| Currency | text |
| End Date | date |
| Holidays | number |
38other output fields
List EOR Contract Documents
SearchPaperwork attached to one hire.
| Field | Type |
|---|---|
ContractRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Signature | text |
| Signed At | date |
| Document Type | text |
| EOR Signature | text |
| EOR Signed At | date |
| Client Job Title | text |
List Global Payroll Payslips
SearchPayslips issued to one global payroll worker.
| Field | Type |
|---|---|
WorkerRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| To | date |
| From | date |
| Status | text |
List Groups
SearchGroups with their managers and archive status.
| Field | Type |
|---|---|
LimitRequired | number |
| Sort Order | choice |
| Include Archived Groups | choice |
| External Metadata | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Status | text |
| Managers | number |
| Created At | date |
| Updated At | date |
| Archived At | date |
| External Metadata | text |
List Invoice Adjustments
SearchInvoice adjustments across all contracts.
| Field | Type |
|---|---|
LimitRequired | number |
| Contract ID | choice |
| Types | choice |
| Statuses | choice |
| Invoice ID | text |
| Reporter ID | text |
| Date From | date |
| Date To | date |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Scale | text |
| Status | text |
| Contract | object |
| ID | text |
| Type | text |
| Title | text |
| Quantity | number |
| Worksheet | object |
| Days | number |
| Hours | number |
| Weeks | number |
| Minutes | number |
| Attachment | object |
| Key | text |
| Filename | text |
| Download URL | text |
| Created At | date |
10other output fields
List Invoice Adjustments by Contract
SearchInvoice adjustment entries limited to a single contract.
| Field | Type |
|---|---|
ContractRequired | choice |
LimitRequired | number |
| Types | choice |
| Statuses | choice |
| Invoice ID | text |
| Reporter ID | text |
| Date From | date |
| Date To | date |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Scale | text |
| Status | text |
| Contract | object |
| ID | text |
| Type | text |
| Title | text |
| Quantity | number |
| Worksheet | object |
| Days | number |
| Hours | number |
| Weeks | number |
| Minutes | number |
| Attachment | object |
| Key | text |
| Filename | text |
| Created At | date |
9other output fields
List Invoices
SearchInvoices issued within a date range.
| Field | Type |
|---|---|
LimitRequired | number |
| Issued From Date | date |
| Issued To Date | date |
| Status | choice |
| Include | choice |
| Field | Type |
|---|---|
| ID | text |
| Label | text |
| Total | text |
| Amount | text |
| Status | text |
| VAT ID | text |
| Paid At | text |
| Currency | text |
| Deel Fee | text |
8other output fields
List Job Titles
SearchJob titles Deel recognizes.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
List Legal Entities
SearchLegal entities with address and VAT data.
| Field | Type |
|---|---|
LimitRequired | number |
| Sort Order | choice |
| Include Archived | boolean |
| Legal Entity ID | text |
| Global Payroll | choice |
| Type | text |
| Country | text |
| Include Payroll Settings | choice |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Phone | text |
| Status | text |
| VAT ID | text |
| Address | object |
| Zip | text |
| City | text |
| State | text |
| Street | text |
| Country | text |
| Country | text |
| Created At | date |
| Sic Number | text |
6other output fields
List Managers
SearchManagers with contact details.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| text | |
| Last Name | text |
| First Name | text |
List Milestones
SearchDeliverables on a milestone contract.
| Field | Type |
|---|---|
ContractRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Title | text |
| Amount | text |
| Status | text |
| Created At | text |
| Description | text |
| Reported By | object |
| ID | text |
| Full Name | text |
| Reviewed By | object |
| ID | text |
| Full Name | text |
| Approval Requested | boolean |
List Off-Cycle Payments
SearchExtra payments paid outside the normal cycle.
| Field | Type |
|---|---|
ContractRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Amount | text |
| Status | text |
| Created At | date |
| Description | text |
| Reported By | object |
| ID | text |
| Full Name | text |
| Currency Code | text |
| Date Submitted | date |
List Offboarding Cases
SearchExit tracker cases for leaving workers.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Hiring Types | choice |
| Progress Statuses | choice |
| Sort By | choice |
| Sort Order | choice |
| Include Overview | choice |
| Ignore Date Range | choice |
| Field | Type |
|---|---|
| Name | text |
| Contract | object |
| ID | text |
| Progress | object |
| Status | text |
| Reference Date | text |
| Reference Date Type | text |
| Reference Date Timezone | text |
| Unique ID | text |
| Hiring Type | text |
| HRIS Profile | object |
| ID | text |
| App Experience | object |
| Is Minimal Requirements | boolean |
| Termination ID | text |
| Offboarding Type | text |
List Onboarding Employees
SearchWorkers moving through onboarding.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Contract ID | array |
| Hiring Types | choice |
| Progress Statuses | choice |
| Countries | array |
| Teams | array |
| Legal Entities | array |
| HRIS Direct Managers | array |
11other input fields
| Field | Type |
|---|---|
| Name | text |
| Worker | object |
| ID | text |
| Name | text |
| Job Title | text |
| Avatar URL | text |
| Is Entity Contractor | boolean |
| Is Contractor Of Record | boolean |
| Country | object |
| Code | text |
| Name | text |
| Profile | object |
| Pic URL | text |
| Contract | object |
| ID | text |
| EOR | object |
| Is Pwac | boolean |
| Effective Date | date |
| Global Payroll | object |
| Offer Letter ID | text |
| Overview | object |
| Banner | object |
| Actions | array |
| Banners | array |
| Profile | object |
| Stepper | array |
| Summary | array |
| Contract | object |
| Progress | object |
| Checklist | object |
| Contracts | array |
| Progress | object |
| Steps | object |
| Status | text |
| Sub Status | text |
| Waiting On | text |
| Reference Date | text |
| Lifecycle Status | text |
| People List Status | text |
| Subject To Overdue | boolean |
| Onboarding Due Date | text |
| Reference Date Type | text |
| Contracts | array |
| Entity | object |
| Status | text |
| Is Main | boolean |
| Is Pwac | boolean |
| Job Title | text |
| Start Date | date |
| Tracker ID | text |
| Worker Type | text |
| Contract ID | text |
| Lifecycle Status | text |
| Unique ID | text |
7other output fields
List Organization Structures
SearchHRIS organization structures and their roles.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Type | text |
| Roles | array |
| ID | text |
| Name | text |
| Teams | array |
| ID | text |
| Name | text |
| Parent | text |
| Children | array |
| Created At | date |
| Name Route | text |
| External ID | text |
| Editable | boolean |
| Created At | date |
| External ID | text |
| Teams Count | number |
2other output fields
List Payments
SearchPayments within a date span.
| Field | Type |
|---|---|
LimitRequired | number |
| Date From | date |
| Date To | date |
| Currencies | array |
| Entities | choice |
| Statuses | choice |
| Field | Type |
|---|---|
| ID | text |
| Label | text |
| Total | text |
| Status | text |
| Paid At | date |
| Timezone | text |
| Total Due | text |
| Created At | date |
| Deel Reference | text |
6other output fields
List People
SearchDirectory of workers and employees.
| Field | Type |
|---|---|
LimitRequired | number |
| Search | text |
| Teams | choice |
| Fields | choice |
| Sort By | choice |
| Sort Order | choice |
| Hiring Statuses | choice |
| Band Placements | choice |
| Comparative Ratios From | text |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| State | text |
| Emails | array |
| Type | text |
| Value | text |
| Country | text |
| Is Pwac | boolean |
| Timezone | text |
| Addresses | array |
| Region | text |
| Country | text |
| Line Two | text |
| Locality | text |
| Postal Code | text |
| Street Address | text |
| Full Name | text |
| Job Title | text |
29other output fields
List Person Custom Fields
SearchCustom fields defined for worker profiles.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Type | object |
| Name | text |
| Currency | text |
| Is Fixed | boolean |
| Options | array |
| Settings | object |
| Access | object |
| Required | boolean |
| Countries | array |
| Is Enabled | boolean |
| Worker Types | array |
| Placement | text |
| Created At | date |
| Description | text |
List Refund Statements
SearchRefunds issued to your account.
| Field | Type |
|---|---|
LimitRequired | number |
| Date From | date |
| Date To | date |
| Currencies | array |
| Entities | choice |
| Field | Type |
|---|---|
| ID | text |
| Label | text |
| Amount | text |
| Status | text |
| Paid At | date |
| Currency | text |
| Created At | date |
| Payment Method | text |
List Roles
SearchRoles tied to an organization structure.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Scope | text |
| HRIS Org Structure ID | text |
List Shift Rates
SearchPay rates defined for shifts.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Name | text |
| Type | text |
| Value | number |
| Created At | date |
| Updated At | date |
| External ID | text |
List Shifts
SearchLogged shifts across contracts.
| Field | Type |
|---|---|
LimitRequired | number |
| From Date | date |
| To Date | date |
| Contracts | choice |
| Field | Type |
|---|---|
| Meta | object |
| End | object |
| Start | object |
| Breaks | array |
| Approval Date | text |
| Summary | object |
| Time Unit | text |
| Time Amount | number |
| Total Break Hours | number |
| Payable Break Hours | number |
| Total Payable Hours | number |
| Shift Duration Hours | number |
| Shift Rate External ID | text |
| Created At | date |
| Shift Type | text |
| Updated At | date |
| Contract ID | text |
| Description | text |
| External ID | text |
| Date Of Work | text |
2other output fields
List Tasks
SearchClaims for finished contract work.
| Field | Type |
|---|---|
ContractRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Amount | text |
| Status | text |
| Attachment | object |
| Key | text |
| Filename | text |
| Description | text |
| Date Submitted | text |
List Teams
SearchTeam directory for your organization.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
List Time Off Events for a Person
SearchBooked leave events for one worker.
| Field | Type |
|---|---|
PersonRequired | choice |
LimitRequired | number |
| Time Off Type ID | text |
| Policy ID | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Policy ID | text |
| Created At | date |
| Updated At | date |
| Event Details | object |
| Birth Date | date |
| Adoption Date | date |
| Was Premature Birth | boolean |
| Estimated Birth Date | date |
| Had Multiple Children | boolean |
| Estimated Adoption Date | date |
| HRIS Profile ID | text |
| Time Off Type ID | text |
List Time Off Policies for a Person
SearchLeave rules that apply to a worker.
| Field | Type |
|---|---|
PersonRequired | choice |
LimitRequired | number |
| Policy Type Name | choice |
| Policy Type ID | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Created At | date |
| Leave Type | text |
| Updated At | date |
| Description | text |
| Policy Type | object |
| ID | text |
| Name | text |
| Payment Type | text |
| Custom Fields | array |
| ID | text |
| Key | text |
| Name | text |
| Schema | object |
| Field Requirement | text |
| Requirement Conditions | array |
23other output fields
List Time Off Requests
SearchLeave requests across your whole workforce.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | choice |
| Time Off IDs | array |
| Start Date | date |
| End Date | date |
| Approval Start Date | date |
| Approval End Date | date |
| Updated Start Date | date |
| Updated End Date | date |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| Amount | text |
| Reason | text |
| Status | text |
| Is Paid | boolean |
| End Date | date |
| Created At | date |
| Deleted At | date |
| Start Date | date |
20other output fields
List Time Off Requests for a Person
SearchRequests for leave filed by a single worker.
| Field | Type |
|---|---|
PersonRequired | choice |
LimitRequired | number |
| Status | choice |
| Time Off IDs | array |
| Start Date | date |
| End Date | date |
| Approval Start Date | date |
| Approval End Date | date |
| Updated Start Date | date |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| Amount | text |
| Reason | text |
| Status | text |
| Is Paid | boolean |
| End Date | date |
| Created At | date |
| Start Date | date |
| Updated At | date |
16other output fields
List Timesheets
SearchTimesheet entries for all contracts.
| Field | Type |
|---|---|
LimitRequired | number |
| Contract ID | choice |
| Statuses | choice |
| Reporter ID | text |
| Date From | date |
| Date To | date |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Scale | text |
| Status | text |
| Contract | object |
| ID | text |
| Type | text |
| Title | text |
| Quantity | number |
| Worksheet | object |
| Days | number |
| Hours | number |
| Weeks | number |
| Minutes | number |
| Attachment | object |
| Key | text |
| Filename | text |
| Created At | date |
9other output fields
List Timesheets by Contract
SearchHours logged under a single contract.
| Field | Type |
|---|---|
ContractRequired | choice |
LimitRequired | number |
| Statuses | choice |
| Reporter ID | text |
| Date From | date |
| Date To | date |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Scale | text |
| Status | text |
| Contract | object |
| ID | text |
| Type | text |
| Title | text |
| Quantity | number |
| Worksheet | object |
| Days | number |
| Hours | number |
| Weeks | number |
| Minutes | number |
| Attachment | object |
| Key | text |
| Filename | text |
| Created At | text |
9other output fields
List Webhook Event Types
SearchCatalog of subscribable webhook events.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Created At | text |
| Updated At | text |
| Description | text |
| Module Name | text |
| Module Label | text |
| Payload Example | text |
List Webhooks
SearchWebhook subscriptions and their state.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | choice |
| Hidden | choice |
| Search | text |
| Order | text |
| Include | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Name | text |
| Stats | object |
| Daily | array |
| Total | number |
| Failed | number |
| Succeeded | number |
| Window Days | number |
| Success Rate | number |
| P95 Latency Ms | number |
| Events | array |
| Hidden | boolean |
| Status | text |
| Internal | boolean |
| Created At | text |
6other output fields
List Working Locations
SearchWork sites you can assign to people.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
Cancel a Time Off Request
ActionLeave request withdrawn in Deel.
| Field | Type |
|---|---|
Time Off Request IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Success | boolean |
Cancel an EOR Amendment
ActionStops a drafted change on a hire.
| Field | Type |
|---|---|
ContractRequired | choice |
Amendment IDRequired | text |
| Field | Type |
|---|---|
| Success | boolean |
Cancel an EOR Contract
ActionCalls off a hire made through employer of record.
| Field | Type |
|---|---|
ContractRequired | choice |
Cancellation ReasonRequired | choice |
| Cancellation Message | text |
| Field | Type |
|---|---|
| ID | text |
| Success | boolean |
Clone a Group
ActionCopies a group into a freshly named one.
| Field | Type |
|---|---|
GroupRequired | choice |
NameRequired | text |
| External Metadata | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Created At | date |
| Updated At | date |
| External Metadata | text |
Confirm an EOR Amendment
ActionApproval step for a drafted EOR change.
| Field | Type |
|---|---|
ContractRequired | choice |
Amendment IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Items | array |
| ID | text |
| Item | text |
| Type | text |
| New Value | text |
| Data Point | text |
| Previous Value | text |
| Scope | text |
| Salary | text |
| Source | text |
| Currency | text |
| End Date | date |
| Holidays | number |
38other output fields
Create a Contract
ActionContractor paperwork with type, team and entity.
| Field | Type |
|---|---|
Contract TitleRequired | text |
Contract TypeRequired | choice |
TeamRequired | choice |
Legal EntityRequired | choice |
Documents RequiredRequired | boolean |
| Main Income | boolean |
| Start Date | date |
| Worker Email | |
| Worker First Name | text |
8other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Quote | object |
| Benefits | array |
| Currency | text |
| Cba Total | number |
| Created At | date |
| Updated At | date |
| Salary Total | number |
| Annual Salary | number |
| Cba Total Usd | number |
| Breakdown Costs | object |
| Salary Total Usd | number |
| Title | text |
| Client | object |
| ID | text |
| Team | object |
| text | |
| Full Name | text |
| Legal Entity | object |
| Status | text |
| Worker | object |
| ID | text |
| text | |
| Image | text |
| Country | text |
| Full Name | text |
| Last Name | text |
| First Name | text |
| Nationality | text |
| Legal Entity | object |
| Date Of Birth | date |
| Job Title | text |
| Seniority | object |
| ID | number |
| Name | text |
| Level | number |
16other output fields
Create a Contract Amendment
ActionProposes revised pay or scope on a running contract.
| Field | Type |
|---|---|
ContractRequired | choice |
| Scale | choice |
| Amount | number |
| Frequency | choice |
| Currency | choice |
| Scope Of Work | text |
| Effective Date | date |
| Job Title | text |
| Special Clause | text |
| Field | Type |
|---|---|
| ID | text |
| Rate | number |
| Scale | text |
| Status | text |
| Created | boolean |
| Job Title | text |
| Worker ID | text |
| Created At | date |
| Updated At | date |
6other output fields
Create a Contract Termination Request
ActionBegins closing a contract, immediately or on a set date.
| Field | Type |
|---|---|
ContractRequired | choice |
| Message | text |
| Terminate Now | boolean |
| Completion Date | date |
| Termination Type | choice |
| Eligible For Rehire | choice |
| Termination Reason | choice |
| Eligible For Rehire Reason | text |
| Field | Type |
|---|---|
| ID | text |
| Completion Date | date |
Create a Global Payroll Contract
ActionGlobal payroll worker with address and holiday terms.
| Field | Type |
|---|---|
TeamRequired | choice |
Legal EntityRequired | choice |
First NameRequired | text |
Last NameRequired | text |
EmailRequired | |
Work EmailRequired | |
StreetRequired | text |
CityRequired | text |
ZipRequired | text |
19other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Client | object |
| Legal Entity | object |
| Status | text |
| Employee | object |
| text | |
| Last Name | text |
| First Name | text |
| Employee Number | text |
| Job Title | text |
| Created At | date |
| Employment | object |
| Type | text |
| State | text |
| Country | text |
| End Date | date |
| Holidays | object |
| Start Date | date |
| Work Visa Required | boolean |
| Compensation Details | object |
| Scale | text |
| Salary | number |
| Currency | text |
Create a Group
ActionOpens a group, optionally tagged with external metadata.
| Field | Type |
|---|---|
NameRequired | text |
| External Metadata | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Created At | date |
| Updated At | date |
| External Metadata | text |
Create a Manager
ActionAdds a person who manages others.
| Field | Type |
|---|---|
EmailRequired | |
Last NameRequired | text |
First NameRequired | text |
| Field | Type |
|---|---|
| ID | text |
| text | |
| Last Name | text |
| First Name | text |
Create a Milestone
ActionDeliverable with a price on a milestone contract.
| Field | Type |
|---|---|
ContractRequired | choice |
TitleRequired | text |
AmountRequired | text |
DescriptionRequired | text |
| Field | Type |
|---|---|
| Created | boolean |
Create a Payment Statement
ActionStatement that pays a group of invoices together.
| Field | Type |
|---|---|
InvoicesRequired | array |
CurrencyRequired | text |
Idempotency KeyRequired | text |
| Payment Method | choice |
| Bank Country | choice |
| Stablecoin Network | choice |
| Field | Type |
|---|---|
| ID | text |
| Amount | text |
| Status | text |
| Paid At | date |
| Invoices | array |
| ID | text |
| Label | text |
| Amount | text |
| Currency | text |
| Is Auto Added | boolean |
| Reference | text |
| Amount Due | text |
| Created At | date |
| Payment Method | text |
5other output fields
Create a Shift Rate
ActionNamed pay rate for shifts, percentage or flat.
| Field | Type |
|---|---|
NameRequired | text |
External IDRequired | text |
| Type | choice |
| Value | number |
| Field | Type |
|---|---|
| Name | text |
| Type | text |
| Value | number |
| Created At | date |
| Updated At | date |
| External ID | text |
Create a Task
ActionFinished work claimed against a task-based contract.
| Field | Type |
|---|---|
ContractRequired | choice |
AmountRequired | text |
DescriptionRequired | text |
Date SubmittedRequired | date |
| Group Key | text |
| Is Auto Approved | boolean |
| Hourly Report Preset ID | text |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | boolean |
Create a Time Off Request
ActionLeave booked for one person across dates.
| Field | Type |
|---|---|
End DateRequired | date |
Start DateRequired | date |
PersonRequired | choice |
| Reason | text |
| Status | choice |
| Is Paid | choice |
| Policy ID | text |
| Description | text |
| Time Off Type ID | text |
1other input field
| Field | Type |
|---|---|
| Amount | text |
| Reason | text |
| Status | text |
| Is Paid | boolean |
| End Date | date |
| Created At | date |
| Deleted At | date |
| Start Date | date |
| Updated At | date |
20other output fields
Create a Timesheet Entry
ActionWorked hours logged for a contract on a date.
| Field | Type |
|---|---|
QuantityRequired | number |
Contract IDRequired | choice |
DescriptionRequired | text |
Date SubmittedRequired | date |
| Group Key | text |
| Is Auto Approved | boolean |
| Hourly Report Preset ID | text |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | boolean |
| Created At | date |
Create a Webhook
ActionEvent subscription delivering to your URL.
| Field | Type |
|---|---|
URLRequired | text |
NameRequired | text |
EventsRequired | choice |
StatusRequired | choice |
API VersionRequired | text |
| Description | text |
| Signing Key | secret |
| Include Child Orgs | boolean |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Name | text |
| Events | array |
| Hidden | boolean |
| Status | text |
| Internal | boolean |
| Created At | text |
| Deleted At | text |
4other output fields
Create an Adjustment
ActionAdds a categorized payment adjustment to a contract.
| Field | Type |
|---|---|
TitleRequired | text |
AmountRequired | text |
Contract IDRequired | choice |
DescriptionRequired | text |
Adjustment Category IDRequired | choice |
| Vendor | text |
| Country | text |
| Odp Only | boolean |
| Cycle Reference | text |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| File | object |
| ID | text |
| Name | text |
| File Type | text |
| Title | text |
| Amount | text |
| Status | text |
| Odp Only | boolean |
| Created At | date |
| Updated At | date |
| Contract ID | text |
7other output fields
Create an Employee
ActionDirect employee with salary, country and start date.
| Field | Type |
|---|---|
TeamRequired | choice |
Legal EntityRequired | choice |
EmailRequired | |
First NameRequired | text |
Last NameRequired | text |
CountryRequired | choice |
NationalityRequired | choice |
Employment TypeRequired | choice |
Start DateRequired | date |
13other input fields
| Field | Type |
|---|---|
| ID | text |
| Employee | object |
| text | |
| Last Name | text |
| First Name | text |
| Work Email | text |
| External ID | text |
| Nationality | text |
| Employment | object |
| Type | text |
| Country | text |
| End Date | date |
| Job Title | text |
| Seniority | text |
| Start Date | date |
| Contract ID | text |
| Part Time Percentage | number |
| Compensation Details | object |
| Scale | text |
| Salary | text |
| Currency | text |
Create an EOR Amendment
ActionDrafts changes to an EOR hire.
| Field | Type |
|---|---|
ContractRequired | choice |
| Scope | text |
| Custom | text |
| Salary | number |
| End Date | date |
| Holidays | number |
| Job Title | text |
| Start Date | date |
| Hourly Rate | number |
15other input fields
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Items | array |
| ID | text |
| Item | text |
| Type | text |
| New Value | text |
| Data Point | text |
| Previous Value | text |
| Scope | text |
| Salary | text |
| Source | text |
| Currency | text |
| End Date | date |
| Holidays | number |
38other output fields
Create an EOR Contract
ActionEmployer of record hire with role, country and start date.
| Field | Type |
|---|---|
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
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Costs | object |
| Summary | object |
| Sections | array |
| Additional Data | object |
| Client | object |
| Legal Entity | object |
| Status | text |
| Employee | object |
| text | |
| Last Name | text |
| First Name | text |
| Legal Name | text |
| Job Code | text |
| Job Title | text |
| Seniority | object |
| ID | number |
| Name | text |
5other output fields
Create an Invoice Adjustment
ActionFiles an extra line on a contractor invoice.
| Field | Type |
|---|---|
TypeRequired | choice |
AmountRequired | number |
Contract IDRequired | choice |
DescriptionRequired | text |
Date SubmittedRequired | date |
| Recurring | boolean |
| Group Key | text |
| Is Auto Approved | boolean |
| Hourly Report Preset ID | text |
| Field | Type |
|---|---|
| ID | text |
| Status | text |
| Created | boolean |
| Created At | date |
Create an Off-Cycle Payment
ActionExtra payment on an irregular schedule.
| Field | Type |
|---|---|
ContractRequired | choice |
AmountRequired | number |
DescriptionRequired | text |
Date SubmittedRequired | date |
| Is Auto Approved | boolean |
| Payment Due Date | date |
| Hourly Report Preset ID | text |
| Field | Type |
|---|---|
| ID | text |
| Created | boolean |
Create Shifts
ActionSeveral time tracking entries logged together.
| Field | Type |
|---|---|
ShiftsRequired | text |
Contract IDRequired | choice |
| Field | Type |
|---|---|
| Meta | object |
| End | object |
| Start | object |
| Breaks | array |
| Approval Date | text |
| Summary | object |
| Time Unit | text |
| Time Amount | number |
| Total Break Hours | number |
| Payable Break Hours | number |
| Total Payable Hours | number |
| Shift Duration Hours | number |
| Shift Rate External ID | text |
| Created At | date |
| Shift Type | text |
| Updated At | date |
| Contract ID | text |
| Description | text |
| External ID | text |
| Date Of Work | text |
2other output fields
Delete a Contract Termination Request
ActionRevokes a pending end-of-contract request.
| Field | Type |
|---|---|
ContractRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Success | boolean |
Delete a Custom Field Value from a Contract
ActionEmpties a stored value held on a contract record.
| Field | Type |
|---|---|
ContractRequired | choice |
Custom FieldRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Success | boolean |
Delete a Custom Field Value from a Person
ActionEmpties one worker profile custom field.
| Field | Type |
|---|---|
WorkerRequired | choice |
Custom FieldRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Success | boolean |
Delete a Group
ActionArchives a group rather than destroying it.
| Field | Type |
|---|---|
GroupRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Archived At | date |
Delete a Milestone
ActionDeliverable removal on a milestone contract.
| Field | Type |
|---|---|
ContractRequired | choice |
MilestoneRequired | choice |
| Field | Type |
|---|---|
| Deleted | boolean |
Delete a Shift
ActionDeletes one logged shift by reference.
| Field | Type |
|---|---|
Shift External IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Success | boolean |
Delete a Shift Rate
ActionShift pay rate removal by external ID.
| Field | Type |
|---|---|
Shift Rate External IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Success | boolean |
Delete a Task
ActionWithdraws a reported piece of contract work.
| Field | Type |
|---|---|
ContractRequired | choice |
TaskRequired | choice |
| Reason | text |
| Field | Type |
|---|---|
| Deleted | boolean |
Delete a Timesheet Entry
ActionDeletes logged worked hours.
| Field | Type |
|---|---|
TimesheetRequired | text |
| Reason | text |
| Field | Type |
|---|---|
| Deleted | boolean |
Delete a Webhook
ActionUnsubscribes a URL from event deliveries.
| Field | Type |
|---|---|
WebhookRequired | choice |
| Field | Type |
|---|---|
| Deleted | boolean |
Delete an Adjustment
ActionRemoves one contract adjustment entry.
| Field | Type |
|---|---|
AdjustmentRequired | text |
| Field | Type |
|---|---|
| Deleted | boolean |
Delete an Invoice Adjustment
ActionRemoves an extra line of a contractor invoice.
| Field | Type |
|---|---|
Invoice AdjustmentRequired | text |
| Field | Type |
|---|---|
| Deleted | boolean |
Delete Multiple Shifts
ActionBulk shift deletion by external identifiers.
| Field | Type |
|---|---|
External IDsRequired | array |
| Field | Type |
|---|---|
| Message | text |
Make an API Call
universalYour own Deel REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query string | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Key | text |
| Value | text |
| Status code | number |
Remove a Contract Invitation
ActionInvalidates an invite already delivered.
| Field | Type |
|---|---|
ContractRequired | choice |
| Field | Type |
|---|---|
| Deleted | boolean |
Request an EOR Termination
ActionStarts an exit for a hired employee.
| Field | Type |
|---|---|
ContractRequired | choice |
ReasonRequired | choice |
Reason DetailRequired | text |
Used Time OffRequired | text |
Is Employee NotifiedRequired | boolean |
| Attachments | text |
| Is Sensitive | boolean |
| Severance Type | choice |
| Desired End Date | date |
8other input fields
| Field | Type |
|---|---|
| ID | text |
| End Date | date |
| Documents | object |
| Supporting | array |
| Offboarding | array |
| Created At | date |
| Updated At | date |
| Contract ID | text |
| Is Sensitive | boolean |
| Request Data | object |
| Reason | text |
| End Date | date |
| Reason Detail | text |
| Used Time Off | object |
| Desired End Date | date |
| Eligible For Rehire | text |
| Eligible For Rehire Reason | text |
| Desired End Date | date |
Review a Task
ActionSingle decision on contract work.
| Field | Type |
|---|---|
ContractRequired | choice |
TaskRequired | choice |
StatusRequired | choice |
| Reason | text |
| Field | Type |
|---|---|
| Created | boolean |
Review a Timesheet
ActionVerdict on one logged hours entry.
| Field | Type |
|---|---|
TimesheetRequired | text |
StatusRequired | choice |
| Reason | text |
| Field | Type |
|---|---|
| Created | boolean |
Review an Invoice Adjustment
ActionDecision on an extra invoice line.
| Field | Type |
|---|---|
Invoice AdjustmentRequired | text |
StatusRequired | choice |
| Reason | text |
| Field | Type |
|---|---|
| Created | boolean |
Review Multiple Tasks
ActionBulk decision on reported contract tasks.
| Field | Type |
|---|---|
ContractRequired | choice |
IDsRequired | array |
StatusRequired | choice |
| Reason | text |
| Field | Type |
|---|---|
| Created | boolean |
Review Multiple Timesheets
ActionBulk decision on logged hours.
| Field | Type |
|---|---|
IDsRequired | array |
StatusRequired | choice |
| Reason | text |
| Field | Type |
|---|---|
| Created | boolean |
Review Time Off Requests
ActionBulk decisions on leave requests.
| Field | Type |
|---|---|
ReviewsRequired | array |
Time Off Request IDRequired | text |
DecisionRequired | choice |
| Field | Type |
|---|---|
| Reviewed | array |
| ID | text |
| Status | text |
| Not Reviewed | array |
| ID | text |
| Error | text |
Send a Contract to a Worker
ActionInvitation delivering a contract for signing.
| Field | Type |
|---|---|
ContractRequired | choice |
| Locale | choice |
| Message | text |
| Field | Type |
|---|---|
| Created | boolean |
Set a Custom Field Value for a Contract
ActionFills in one contract attribute you defined.
| Field | Type |
|---|---|
ContractRequired | choice |
Custom FieldRequired | choice |
DataRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Success | boolean |
Set a Custom Field Value for a Person
ActionSaves a value for a worker attribute.
| Field | Type |
|---|---|
WorkerRequired | choice |
Custom FieldRequired | choice |
DataRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Success | boolean |
Sign a Contract
ActionClient countersignature for a contract.
| Field | Type |
|---|---|
ContractRequired | choice |
Client SignatureRequired | text |
| Contract Template ID | number |
| Field | Type |
|---|---|
| Created | boolean |
Update a Contract External ID
ActionAttaches your own reference to a contract.
| Field | Type |
|---|---|
ContractRequired | choice |
| External ID | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Quote | object |
| Benefits | array |
| Currency | text |
| Title | text |
| Client | object |
| ID | text |
| Team | object |
| text | |
| Full Name | text |
| Legal Entity | object |
| Status | text |
| Worker | object |
| ID | text |
| text | |
| Country | text |
| Full Name | text |
| Last Name | text |
| First Name | text |
| Nationality | text |
| Date Of Birth | text |
| Expected Email | text |
| Alternate Email | array |
| Job Title | text |
| Seniority | object |
| ID | number |
| Name | text |
| Level | number |
20other output fields
Update a Department
ActionReassigns a worker to a department.
| Field | Type |
|---|---|
PersonRequired | choice |
DepartmentRequired | choice |
| Replace Other Positions | choice |
| Effective Date | date |
| Field | Type |
|---|---|
| Updated | boolean |
Update a Group
ActionGives a group a different title.
| Field | Type |
|---|---|
GroupRequired | choice |
NameRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Created At | date |
| Updated At | date |
| External Metadata | text |
Update a Shift
ActionRevises a logged worked shift.
| Field | Type |
|---|---|
Shift External IDRequired | text |
| Summary | text |
| Description | text |
| Date Of Work | date |
| Payroll Cycle Ref | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| Meta | object |
| End | object |
| Start | object |
| Breaks | array |
| Approval Date | text |
| Summary | object |
| Time Unit | text |
| Time Amount | number |
| Total Break Hours | number |
| Payable Break Hours | number |
| Total Payable Hours | number |
| Shift Duration Hours | number |
| Shift Rate External ID | text |
| Created At | date |
| Shift Type | text |
| Updated At | date |
| Contract ID | text |
| Description | text |
| External ID | text |
| Date Of Work | text |
2other output fields
Update a Shift Rate
ActionRevises a pay rate for shifts.
| Field | Type |
|---|---|
Shift Rate External IDRequired | text |
| Name | text |
| Type | choice |
| Value | number |
| Field | Type |
|---|---|
| Name | text |
| Type | text |
| Value | number |
| Created At | date |
| Updated At | date |
| External ID | text |
Update a Task
ActionRevises a task reported on a contract.
| Field | Type |
|---|---|
Task IDRequired | text |
| Amount | text |
| Description | text |
| Hourly Report Preset ID | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| Created At | date |
| Updated At | date |
Update a Time Off Request
ActionReschedules leave already requested.
| Field | Type |
|---|---|
Time Off Request IDRequired | text |
End DateRequired | date |
Start DateRequired | date |
PersonRequired | choice |
| Reason | text |
| Is Paid | choice |
| Policy ID | text |
| Description | text |
| Time Off Type ID | text |
| Field | Type |
|---|---|
| Amount | text |
| Reason | text |
| Status | text |
| Is Paid | boolean |
| End Date | date |
| Created At | date |
| Deleted At | date |
| Start Date | date |
| Updated At | date |
20other output fields
Update a Timesheet Entry
ActionCorrects hours logged on a timesheet.
| Field | Type |
|---|---|
TimesheetRequired | text |
QuantityRequired | number |
DescriptionRequired | text |
| Hourly Report Preset ID | text |
| Field | Type |
|---|---|
| Updated | boolean |
Update a Webhook
ActionReconfigures an existing webhook subscription.
| Field | Type |
|---|---|
WebhookRequired | choice |
| URL | text |
| Name | text |
| Replace Events | choice |
| Status | choice |
| Description | text |
| Include Child Orgs | choice |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Name | text |
| Events | array |
| Hidden | boolean |
| Status | text |
| Internal | boolean |
| Created At | text |
| Deleted At | text |
4other output fields
Update a Working Location
ActionAssigns a worker to another work site.
| Field | Type |
|---|---|
PersonRequired | choice |
Working LocationRequired | choice |
| Field | Type |
|---|---|
| Updated | boolean |
Update an Adjustment
ActionRevises fields of a contract adjustment.
| Field | Type |
|---|---|
AdjustmentRequired | text |
| File | text |
| Title | text |
| Amount | text |
| Country | text |
| Odp Only | choice |
| Description | text |
| Vendor Name | text |
| Date Of Adjustment | date |
2other input fields
| Field | Type |
|---|---|
| Updated | boolean |
Update an Invoice Adjustment
ActionRewrites details of an invoice adjustment.
| Field | Type |
|---|---|
Invoice AdjustmentRequired | text |
| Title | text |
| Amount | number |
| Description | text |
| Field | Type |
|---|---|
| Updated | boolean |
Update Personal Information
ActionEdits the personal record of a worker.
| Field | Type |
|---|---|
WorkerRequired | choice |
| Work Email | |
| Date Of Birth | date |
| Phone Numbers | text |
| Personal Email | |
| Preferred Name | text |
| Legal Last Name | text |
| Legal First Name | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Success | boolean |
Validate a Time Off Request
ActionDry run that checks a leave request.
| Field | Type |
|---|---|
End DateRequired | date |
Start DateRequired | date |
PersonRequired | choice |
| Is Paid | choice |
| Policy ID | text |
| Description | text |
| Time Off Type ID | text |
| Field | Type |
|---|---|
| Dates | array |
| Date | date |
| Type | text |
| Hours | array |
| Amount | text |
| Day Types | array |
| Holiday Name | text |
| Time Off Percentage | text |
| Amount | text |
| Is Valid | boolean |
| New End Date | date |
| Custom Fields | array |
| ID | text |
| Key | text |
| Name | text |
| Schema | object |
| Field Requirement | text |
| Requirement Conditions | array |
| Is Event Based | boolean |
| New Start Date | date |
| Remaining Balance | text |
| Require Attachment | boolean |
9other output fields
Templates
Look for Deel templates in the WEXTL template library.
Browse templates →Other HR integrations on WEXTL
BambooHR[2]HRIS for employee records, time off, time tracking, benefits, hiring, and payroll-adjacent workflows.
CATSApplicant tracking system for recruiting agencies and hiring teams.
actiTIMETime tracking and project work-assignment software for teams and leave management.
7ShiftsRestaurant employee scheduling, time tracking, and team management.
ConnecteamEmployee app for deskless teams covering scheduling, tasks, forms, and internal communication.
References
- WEXTL® Deel Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Deel.
- 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.





























