Deel
Bring new starters, changes and leavers from Deel into every system that needs them, with HR approving each change.
37 ways to read, 5 ways to write, each write switched on by you.
Quality checks
Built and tested with example responses.
- Ready to connect: doneEvery listed action is built in.
- Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
Connected, approved, proven.
The things teams do most with Deel, an example flow with a person in the loop, and what Nexra keeps as proof.
Top actions
- Create time-off requestApproval by rule
- Create timesheet entryApproval by rule
- List gross-to-net report rowsRead
Example flow
- Deel · List gross-to-net report rowsDone
- Deel · Create time-off requestNeeds approval
- Nexra · Record the decision and result in the evidence chainProven
Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches Deel.
What gets logged
- Whether it ran on its own or who approved it, and under which rule
- A fingerprint of the exact request sent to Deel
- Deel's reply: what it created or changed
- One entry in the evidence chain, linked to the one before
Try this in the sandbox
Run the whole flow with test data in your sandbox, then connect a Deel, Inc. test account before you go live.
For developers
Technical detail
Read Deel people, contracts, org structure, legal entities, invoices, payslips and payroll reports; create and update time off, timesheets and custom field values.
Deel, Inc. API docs- Source actions
- 37
- Destination actions
- 5
- Data types
- 30
What you can map
Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.
Contract custom field values1
- List contract custom field valuesSource
Custom field values stored on one contract.
Contract custom fields1
- List contract custom fieldsSource
Custom field definitions on contracts, with type, options and settings.
Contracts2
- Get contractSource
One contract by ID.
- List contractsSource
Contracts with worker, status, signatures, cost centres and custom fields.
Cost centers1
- List cost centersSource
Cost centers configured for a legal entity.
Custom fields1
- List people custom fieldsSource
Custom field definitions on people.
Deel invoices1
- List Deel invoicesSource
Invoices Deel issued to the organization for its fees (read only).
Departments1
- List departmentsSource
Organization departments with their parent.
Eor contracts1
- Get EOR contract detailsSource
Employer of Record contract terms: status, salary, schedule, seniority and dates.
Eor payslips1
- List EOR payslipsSource
Payslip metadata (period and status) for an EOR employee.
Gp payslips1
- List Global Payroll payslipsSource
Payslip metadata (period and status) for a Global Payroll employee.
Gross to net reports1
- List gross-to-net report rowsSource
Gross-to-net rows of a Global Payroll report, optionally converted to a currency.
Groups1
- List groupsSource
Deel groups with their status and managers.
Invoice adjustments2
- Get invoice adjustmentSource
One invoice adjustment by ID (read only).
- List invoice adjustmentsSource
Bonuses, expenses, deductions and other line items reported on contracts (read only).
Invoices2
- Get invoiceSource
One invoice by ID (read only).
- List invoicesSource
Contractor invoices (read only). Set status to all to include unpaid invoices.
Legal entities2
- Get legal entitySource
One legal entity with registration, VAT and address details.
- List legal entitiesSource
Legal entities of the organization.
Managers1
- List managersSource
Organization managers.
Milestones1
- List contract milestonesSource
Milestones submitted on a milestone-based contract.
Organization structures2
- Get organization structureSource
One HRIS organization structure by ID.
- List organization structuresSource
HRIS organization structures with their teams, hierarchy and external IDs.
Organizations1
- Get current organizationSource
The organization the token belongs to.
Payroll cycle gross to net1
- List payroll cycle gross-to-netSource
Itemised gross-to-net data per contract for one payroll cycle.
Payroll cycles1
- List payroll cyclesSource
Regular and off-cycle payroll cycles of a legal entity, with G2N availability.
Payroll groups1
- List payroll groupsSource
Payroll groups and calendars of a Global Payroll legal entity.
Payroll reports1
- List Global Payroll reportsSource
Global Payroll events (reports) of a legal entity with period and lock dates.
People2
- Get personSource
One person by HRIS profile ID, with custom fields.
- List peopleSource
Workers across contractor, EOR, PEO and direct employment.
Person custom field values2
- List person custom field valuesSource
Custom field values stored on one worker.
- Set person custom field valueDestinationProvider duplicate protectionApproval before production
Creates or overwrites one custom field value on a worker.
Teams1
- List teamsSource
Deel teams (groups contracts are assigned to).
Time off entitlements1
- List time-off entitlementsSource
Balances per policy for one worker: available, used, requested and accrued.
Time off policies1
- List time-off policiesSource
Organization time-off policies with types, allowances and tracking units.
Time offs3
- Create time-off requestDestinationProvider duplicate protectionApproval before production
Requests time off for a worker's HRIS profile.
- List time offSourceIncremental
Time-off requests across the organization.
- Update time-off requestDestinationProvider duplicate protectionApproval before production
Corrects the dates, type or reason of an existing time-off request.
Timesheets4
- Create timesheet entryDestinationProvider duplicate protectionApproval before production
Submits work quantity for a time-based contract.
- Get timesheetSource
One timesheet entry by ID.
- List timesheetsSource
Submitted work for time-based and pay-as-you-go contracts.
- Update timesheet entryDestinationProvider duplicate protectionApproval before production
Changes the quantity and description of a timesheet entry.
Access and limits
- Authentication
- Deel organization API token
- Plans and access
- Any Deel organization; API tokens are created by organization admins. Use an organization token with scopes people:read, people:write, organizations:read, contracts:read, legal-entity:read, time-off:read, time-off:write, worker:read, worker:write, timesheets:read, timesheets:write, accounting:read, invoice-adjustments:read, milestones:read, payslips:read, global-payroll:read and groups:read.
- Test environment
- Deel sandbox organizations use api-staging.letsdeel.com.
- Rate limits
- 5 requests per second per organization across all tokens; HTTP 429 when exceeded.
- Pagination
- People, timesheets, invoices, invoice adjustments and org structures use limit/offset; contracts, legal entities and groups use a page cursor; time off and policies use page_size and next; payroll cycles and gross-to-net data use next_cursor while has_more is true.
- Provider events
- Deel webhooks for contract, people, time-off, timesheet and invoice events. Flows run on demand, on a schedule, or when a scheduled check finds new or changed records.
Before you build a flow
- Only time off has an updated-since filter; people, contracts, timesheets and invoices are read in full.
- Multi-value filters accept a single value each, because the array query encoding is not documented.
- Time-off requests are created as REQUESTED unless APPROVED is mapped explicitly; Deel defaults to APPROVED.
- Contracts, invoices, payslips and payroll reports are read only. Contract creation is excluded because Deel documents POST /contracts as creating a live contractor contract, not a draft; signing, invitations, amendments, terminations, off-cycle payments, on-demand payroll, payments and payouts are intentionally not implemented. Deletes are not implemented.
- Contract custom field values are read only: Deel documents PUT /contracts/{id}/custom_fields as a full replacement that removes values not sent. Person custom field values can be written one field at a time.
- Payslip operations return metadata (period and status) only; PDF download links are not requested. EOR payslips are keyed by worker ID and Global Payroll payslips by GP worker ID.
- Gross-to-net report rows are returned as provider objects because Deel does not publish a fixed column schema for them.
- Payroll groups are read without paging because the `pagination` object's query encoding is not documented.
- Personal data such as birth dates, addresses and bank details is not mapped.
Developer reference
- Create the Deel, Inc. credentials described above with the narrowest permissions your flows need.
- In Nexra, open Connect, then Connections, then New connection, choose Deel, enter its settings and credentials, and tick only the write actions you need. Connection guide
- Test the connection, then use its actions as flow sources and destinations. Flow guide
Machine-readable detail: GET /api/public/connect/connectors/deel and the Connections API.
