Deel integration

Receives real-time notifications for specific events across your Deel organization (e.g., contracts, timesheets, payslips, payments).

Returns a signed, time-limited HTTPS URL to download the invoice PDF for embedded worker flows.

Retrieves detailed invoice information by its public ID for reference or verification purposes.

Submit worker's personal details, contract association, profile type, and company information.

Submit a new tax form for the authenticated worker against a specific client legal entity. Valid forms are W9_INDIVIDUAL, W9_COMPANY, W8_BEN, W8_BEN_E.

Returns a paginated list of all tax forms owned by the authenticated worker, ordered by creation date descending.

Returns detailed information about a single person in the organization by their public ID. Includes personal details, employment information, and organizational structure.

Creates a people-only record. Suitable for pre-boarding, contingent workers, or scenarios where a contract is not yet applicable.

Supports filtering by search term, teams, custom fields, and other query parameters. Build people directories or sync HR data.

Sets the working location for a worker identified by their HRIS profile ID.

Provisions both a person and an associated employment contract under the organization's own legal entity.

Sets an external identifier for a contract. Useful for linking ERP keys or employee numbers.

Retrieves the full record for a specific contract by ID, including status, compensation, worker details, and metadata.

Returns a paginated list of contracts for the organization, with optional filtering.

Retrieves the standardized list of termination reasons to present when initiating a contract termination.

Returns a secure, time-limited URL for downloading the PDF version of the contract identified by contract_id.

Records the worker's signature on a pending amendment. Once signed, the amendment's status change is reflected.

Updates the employer approval status for a pending equity exercise.

Whether the contract is paid through Deel (STANDARD) or outside Deel (OFF_PLATFORM).

Associates the specified option grant and stakeholder details with a worker. Created in a pending state.

Records the worker's signature on the contract. Only unsigned, pending contracts can be signed.

Rejects a contract provided it is currently in a pending, unsigned state. Contracts that have already been signed or previously rejected are not eligible.

Returns all contract templates available to the organization, including fixed-rate, pay-as-you-go, and milestone-based types.

Employee acknowledges their EOR assignment agreement as part of project initiation. Ensure all terms are reviewed.

Kicks off generation of an employee agreement template PDF draft. Poll with task_id until is_processing is false to get the signed URL.

Returns configuration for available countries. If no configuration exists for a country, all data points are treated as enabled.

Cancels the EOR contract identified by its OID. The contract must be in an active or pending state to be eligible for cancellation.

Defers the scheduled onboarding start date for the EOR employee on the specified contract.

Retrieves the versioned form definition for creating an EOR contract in the specified country, including fields, validation rules, and conditional logic.

Returns the earliest allowed start date for a new EOR contract quote based on the specified employment country, nationality, and visa requirements.

Returns the allowances and non-statutory additional costs available for inclusion in an EOR contract quote for the specified country.

Returns benefits available in a specific country, scoped by work visa requirement, weekly work hours, employment type, team, and legal entity.

Returns country-specific hiring guide data — including salary requirements, holidays, probation terms, health insurance, and currency.

Applies a signature and job title to a specified EOR contract document. Currently only the FRAMEWORK_AGREEMENT document type is supported.

Updates employee information on an EOR contract (e.g. first and last name). Only permitted when the contract is in specific pre-active states.

Returns a list of workers currently going through onboarding, including contract details, HRIS profile information, current onboarding status, and onboarding due dates.

Returns detailed onboarding progress, stepper actions, contract info, and HRIS profile info.

Returns detailed onboarding progress, stepper actions, contract info, and HRIS profile info.

Returns a list of contracts currently in the offboarding process. By default, results are scoped to a 45-day date range; set ignore_date_range to true to retrieve all terminations.

Retrieve complete offboarding and termination details associated with an HRIS profile identifier.

Returns termination details for a contract identified by its unique, base64-encoded offboarding tracker ID.

Cancels a pending termination request for the specified contract, reverting the contract to its pre-termination state.

Initiates termination of an active contract, recording the termination reason, effective date, and any final payment details.

Retrieves the country-specific additional information fields required for GP workers to run payroll in compliance with local regulations. Use this to render dynamic form fields.

Update the employment type (full-time, part-time, or on leave) and FTE for a Global Payroll contract.

Returns a pre-signed, temporary download URL for a specific Global Payroll (GP) employee payslip PDF.

Returns the payslip history for a GP employee, including each payslip's date range and status. Restricted to GP contract types.

Retrieves a payment statement by its id, including its status, amounts, beneficiary details, and the authoritative list of settled invoices.

Creates a payment statement for the given invoices, attaches a bank transfer method for the requested country and currency, optionally applies available balance, and pays it in a single call.

Creates an invoice adjustment (bonus, commission, VAT, deduction) against a contract. Can optionally be made recurring.

Permanently removes an invoice adjustment by its ID.

Retrieves detailed information about a single invoice line item (adjustment) by its unique identifier.

Returns invoice adjustments, optionally filtered by contract, adjustment type, status, invoice, reporter, or submission date range.

Retrieves invoice line items (adjustments) associated with a given contract_id.

Submits an approve or decline review decision for a single invoice adjustment.

Applies a partial update to an existing invoice adjustment; only fields included in the request body are modified.

Returns a paginated list of invoices; by default only paid invoices are returned, but passing 'status=all' returns invoices in all statuses.

Use this endpoint to retrieve a list of refund statements to review past transactions and reconcile accounts.

Returns a paginated list of invoices specifically for Deel platform fees.

Returns a temporary, time-limited download URL for an invoice PDF.

Returns a breakdown of a payment made to Deel, with individual invoices and the Deel fee included as discrete line items.

Returns a cursor-paginated list of payments to Deel, including worker details, payment status, and payment methods.

Returns time-off entitlements for the specified hris_profile_id, including available balances, used days, and remaining allocation per time-off type.

Applies a partial update to an existing time-off request without requiring the worker to cancel and resubmit it.

Cancels the time-off request identified by time_off_id. This action immediately sets the request to CANCELED regardless of its current status and cannot be reversed.

Returns policy validation templates and policy types for one or more countries.

Returns holidays, work schedule entries, and time-off dailies for a given date range, scoped to HRIS profile IDs or countries.

Creates a new time-off request. Can include detailed dates breakdowns and handle event-based policies.

Returns a paginated list of time-off requests for the specified hris_profile_id, with optional filters.

Validates a time-off request against policy compliance, available balance, blackout dates, and other rules before the request is created.

Approves or rejects a batch of time-off requests in a single call. Rejecting a time-off request is irreversible.

Upserts or deletes time-off requests for Global Payroll contracts based on external IDs.

Returns time-off events for a worker profile identified by hris_profile_id, with optional filtering.

Returns the time-off policies assigned to the specified hris_profile_id, including policy details such as allowed types, accrual rules, and balances.

Returns time-off requests for the authenticated organization, with optional filtering by status, date ranges, and policy types.

Returns a short-lived presigned URL to download a time-off attachment directly from object storage.

Updates a timesheet entry. Only fields provided in the payload will be modified.

Retrieves the details of a single timesheet entry by its unique identifier.

Submits an approve or decline review decision for a timesheet.

Creates a timesheet entry recording the contract, date, hours worked, and an optional description.

Returns a paginated list of timesheets in the account, optionally filtered by contract_id, contract_types, statuses, reporter_id, or date range.

Retrieves timesheets associated with a given contract_id, with optional filtering.

Returns benefits associated with the specified EOR contract, including plan details, provider info, and enrollment status.

Creates a new job in the ATS. Use this after an interview plan, team, location, and employment type have been determined.

Returns a paginated list of ATS jobs. Filter postings by search text, interview plan, location, team, employment type, department, status, or last-updated time.

Add a candidate to the ATS with required information (name and email) and optional details like phone, LinkedIn profile, and CV.

Replaces all existing tags on a candidate with the provided set of tag IDs. Any tags not included will be removed.

Returns a paginated list of candidates, optionally filtered by job IDs, department IDs, tag IDs, current stage category, etc.

Adds a note to a specific application. The author_id must correspond to a valid HRIS user.

Associates an application with an interview plan stage. Can advance the current stage or record a historical stage.

Creates a new ATS application linking an existing candidate to an existing job. Both the candidate and job must exist prior to this call.

Returns a cursor-paginated list of candidate applications across all open positions for the organization.

Retrieves a single ATS application by its application_id, including job, candidate, and submission metadata.

Retrieves the details of an immigration case by its case ID from the client perspective.

Retrieves the details of an immigration case document by its document ID.

Returns available business visa options along with their fees, estimated timelines, and qualification criteria.

Returns the right-to-work onboarding case for a worker, including any associated documents.

Retrieves a paginated list of immigration cases with filters for applicant name, case type, status, and country.

Returns the visa types supported for immigration processing in a country, identified by its Alpha-2 country code.

Returns a paginated list of immigration cases, optionally filtered by applicant name, case type, status, and country.

Uploads a document against a specific case document requirement and submits it for review. The endpoint expects multipart/form-data with a JSON string inside the 'data' part.

Retrieves the details of a specific document requirement within a worker's immigration case, including current status.

Get detailed information for a specific immigration case (worker context). Response is enriched with applicant profile, visa type, case status, estimated completion date, etc.

Creates a new immigration case for a worker. The appropriate visa type must be determined before calling this endpoint.

Retrieves the externally-visible notes for an immigration case, most recent first.

Creates a new legal entity under the organization and returns the entity record including its assigned ID.

Archives the legal entity identified by id, marking it as inactive without permanently removing it.

Applies a partial update to an existing legal entity identified by id; only fields included in the payload are modified.

Lists industry subcategories with their parent category details and NAICS codes, supporting cursor-based pagination and sorting.

Returns a paginated list of legal entities in the account, with optional filtering by country, entity type, global payroll flag, and archived status.

Controls whether employees under this legal entity can access the Deel employee app for self-service tasks such as viewing payslips.

Returns details of the organization associated with the authentication token; the organization is resolved automatically from the token and requires no additional identifier.

Creates a child organization linked to the parent organization, provisioning a scoped API token, a default group, and an initial user assignment.

Applies a partial update to the custom role, modifying only the fields supplied in the request body.

Returns the list of departments within the authenticated user's organization, including each department's identifier, name, and parent department where applicable.

Issues a short-lived session token (valid 6 hours) for a child organisation. Session tokens do not affect the child organisation’s original permanent token.

Returns the list of teams within the authenticated user's organization, with each entry including the team's ID and name.

Retrieves all roles defined within the current organization.

Creates a new custom role within the current organization.