How do AI agents use Deel through Open Connector?

Your user connects Deel once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes Deel tools to your agent over MCP or a typed API, with credentials injected server-side on each call.

Is this a Deel MCP server?

Yes. Open Connector can serve Deel as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call Deel actions with credentials injected server-side.

Where do Deel credentials live?

In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

Deel integration

Deel integration for AI agents.

Deel integration for AI agents with secure authentication and server-side credential injection. Open Connector runs the OAuth, seals the token in an encrypted vault, and serves Deel tools to your agent over MCP or a typed API — credentials injected server-side, every call audited, nothing leaving your infrastructure. Open source (AGPL-3.0) and self-hostable.

View source on GitHub All integrations →

What your agents can do

Real Deel actions, managed and audited.

Your user connects Deel once; your agent can then secure AI-agent actions — scoped to the OAuth permissions you grant and the tool allowlist you configure. Every action is least-privilege and written to a tamper-evident audit trail.

1
Your user grants Deel access once (OAuth) — the token lands in the vault.
2
Your agent calls a tool over MCP or the typed API; Open Connector injects the credential server-side.
3
Every routed call appends a hash-chained audit record — nothing leaves your infra.

Tools & triggers

Supported Deel tools.

391 tools are generated from the published Deel catalog. Descriptions are plain text; each action remains subject to its configured authentication and tool allowlist.

Showing 391 tools. All published catalog entries are included in this page's server-rendered HTML.

Accept a contract amendment on behalf of the client.: Accepts a pending amendment on an EOR worker contract, formally approving the proposed modifications on the client's behalf. The amendment must already exist and be in a pending state before this operation can be called. **Token scopes**: `contracts:write`; EOR
Accept EOR project assignment as client: Records client approval of a project assignment for an EOR contract, confirming that the terms have been reviewed and accepted. **Token scopes**: `contracts:write`; EOR
Acknowledge a compliance document: Submits the worker's consent acknowledgement for a compliance document that requires it. This operation is required before documents marked as needing acknowledgement are considered complete. **Token scopes**: `worker:write`; EOR
Acknowledge assignment agreement: Employee acknowledges their assignment agreement as part of project initiation. Ensure all terms in the agreement are reviewed before acknowledgment. **Token scopes**: `worker:write`; EOR
Add additional information: Adds supplemental information fields to an EOR employee's contract record. **Token scopes**: `worker:write`; EOR
Add bank account: Registers a bank account for an EOR employee. Returns the `id` of the newly created bank account record. **Token scopes**: `worker:write`; EOR
Add Candidate: Creates a candidate record for contractor onboarding outside of an ATS flow. The returned record can be used in subsequent contract creation calls. **Token scopes**: `candidates:write`; Candidates
Attach a file to contract: Uploads a file and attaches it as a document to the specified contract by creating an amendment with the attachment. Only supported for ongoing_time_based, milestones, payg_tasks, time_based, pay_as_you_go_time_based, and eor contract types. **Token scopes**: `contracts:write`; Contracts
Add/Edit Bank Details: Creates or updates an employee's bank payout method. If a method already exists, the existing record is superseded and the response includes a version identifier and activation status reflecting the updated state. **Token scopes**: `worker:read`, `worker:write`; Payouts
Add external Id: Sets an external identifier. Link your internal reference IDs, such as employee numbers or ERP keys, to a Deel worker. The external ID must be unique and, once set, can be used as a filter when listing contracts to directly look up Deel records from an external system. **Token scopes**: `contracts:write`; Contracts
Add bank account: Adds a bank account for the GP worker; country-specific field requirements must be retrieved from `GET /gp/workers/{worker_id}/banks/guide` before submitting. **Token scopes**: `people:write`; Global Payroll
Add GP Workers Additional Information: Adds supplementary fields to the contract, with the extra data supplied under the `data` object in the request body. **Token scopes**: `people:write`; Global Payroll
Add note to an application: Adds a note to a specific application. The `author_id` must correspond to a valid HRIS user. **Token scopes**: `ats:write`, `ats.applications.notes:write`; ATS
Add off-cycle payment: Creates a new invoice line item for an off-cycle payment against a specific contract, for use when a payment must be issued outside the regular payment schedule. **Token scopes**: `off-cycle-payments:write`; Off-cycle Payments
Amend contract: Submits an amendment to modify the details of an existing contract. If the contract is already signed or active, the amendment must be approved and re-signed before the changes take effect. **Token scopes**: `contracts:write`; Contractors
AML API for Whitelabel - Data retrieval: Returns the most recent AML screening result for the specified entity. The `entity_type` must be one of `profile`, `hris_profile`, or `legal_entity`. **Token scopes**: `screenings:read`; Screenings
Apply changes to positions.: Applies a batch of add, edit, and delete operations to positions within a single request. Multiple operation types may be submitted together; callers should ensure each operation in the batch targets a valid, existing position where applicable. **Token scopes**: `profile:write`; Positions
Approve an equity exercise: Updates the employer approval status for a pending equity exercise. This is a partial update — only `employer_approval` is accepted in the request body. **Token scopes**: `contracts:write`; Contracts
Approve or reject time-off requests: Approves or rejects a batch of time-off requests in a single call. The desired status must be either APPROVED or REJECTED for each entry. Only time-offs currently in REQUESTED status can be reviewed; entries in any other status are returned as not reviewed. Rejecting a time-off request is irreversible: once rejected, its status cannot be changed through this API. The response distinguishes successfully processed requests from those that encountered errors. **Token scopes**: `time-off:write`; Time Off
Assign cost centers to an employment contract: Assign cost centers to employment by contract id **Token scopes**: `contracts:write`; Cost Centers
Associate application with an interview plan stage: Associates an application with a specific interview plan stage. Set `is_current_stage` to `true` to advance the application's active stage, or `false` to record a historical stage entry without changing the current stage. Pass `applicable_job_activities` to selectively trigger activities, omit it to trigger all, or pass an empty array to trigger none; if archiving the candidate, include `candidate_archivation_reason_id` and optionally `candidate_archivation_email_template_id` to send a rejection email. **Token scopes**: `ats:write`; ATS
Attach entries to On-Demand Payroll: Attaches existing eligible entries to an On-Demand Payroll that is awaiting client review before submission. **Token scopes**: `on-demand-payroll:write`; On-Demand Payroll
Upsert tags in bulk: Use this endpoint to create or update tags for candidate, job, or opening groups in bulk. Provide both tag_id and tag_name to update an existing tag label. Omit tag_id to create a new tag or match an existing one case-insensitively. **Token scopes**: `ats:write`; ATS
Calculate Employee Costs Globally: Calculates the total employment cost for an EOR arrangement in a specified country, returning a breakdown that includes employer costs, benefits, platform fees, and severance accrual.; EOR
Cancel amendment: Cancels a pending EOR contract amendment, voiding the request and preventing it from being reviewed or applied to the contract. **Token scopes**: `contracts:write`; EOR
Cancel EOR Contract: Cancels the EOR contract identified by oid. The contract must be in an active or pending state to be eligible for cancellation. **Token scopes**: `contracts:write`; EOR
Cancel On-Demand Payroll: Cancels an On-Demand Payroll, optionally keeping the specified entries available for a future regular payroll cycle. **Token scopes**: `on-demand-payroll:write`; On-Demand Payroll
Cancel time-off request: Cancels the time-off request identified by time_off_id. Use this when a previously submitted or approved time off needs to be withdrawn. This action immediately sets the request to CANCELED regardless of its current status and cannot be reversed. **Token scopes**: `time-off:write`, `worker:write`; Time Off
Change EOR Mailbox Password: Changes the mailbox password for an EOR worker. **Token scopes**: `worker:write`; EOR
Change the auto-withdrawal setting: Partially updates the auto-withdrawal configuration, allowing callers to enable or disable auto-withdrawal and change the target withdrawal method. **Token scopes**: `worker:write`; Payouts
Clone a Group: Creates a new group by copying the structure and settings of an existing group. The cloned group is independent of the source after creation. **Token scopes**: `groups:write`; Groups
Confirm an existing contract amendment: Confirms a draft amendment on an EOR contract and initiates the review process, routing it to Deel and the employee for acknowledgment and approval. The amendment must exist in a confirmable state prior to calling this endpoint. **Token scopes**: `contracts:write`; EOR
Create a bank transfer method: Registers a new bank transfer payout method; the request payload structure is dynamic and determined by the selected option, so callers should retrieve field requirements before submitting. **Token scopes**: `worker:read`, `worker:write`; Payouts
Create a direct employee: Creates a direct employee record in Deel's HRIS, hired under the organization's own legal entity. Provisions both a person and an associated employment contract. Applicable when onboarding employees managed through your own payroll providers. It can support downstream integrations, such as IT equipment orders. **Token scopes**: `people:write`; People
Create a Global Payroll (GP) contract: Creates a new Global Payroll contract. Country-specific fields required in the request body vary by country and must be retrieved in advance from `GET /forms/gp/worker-additional-fields/{country_code}`. Returns the created contract including its unique `id`. **Token scopes**: `contracts:write`; Global Payroll
Create an EOR contract amendment: Creates a new amendment for an existing EOR contract, supporting changes to terms such as salary, currency, effective date, and other contract conditions. All requests are validated against applicable business and regulatory rules before the amendment is accepted. **Token scopes**: `contracts:write`; EOR
Create an EOR contract: Submits details for an Employee of Record (EOR) contract and returns a quote. Deel processes the submitted information and returns pricing, compensation, and health plan details before the contract is activated. **Token scopes**: `contracts:write`; EOR
Create an immigration case: Creates a new immigration case for a worker. The appropriate visa type must be determined before calling this endpoint. **Token scopes**: `immigration:write`; Immigration
Create an invoice adjustment: Creates an invoice adjustment — such as a bonus, commission, VAT percentage, or deduction — against a contract. Pass the `recurring` query parameter to apply the adjustment automatically to future invoices. **Token scopes**: `invoice-adjustments:write`, `worker:write`; Invoices
Create a new adjustment: Creates a new payroll adjustment for a contract, modifying the payment amount on the next payment cycle. The `adjustment_category_id` must reference a valid category retrieved from `GET /adjustments/categories`. **Token scopes**: `adjustments:write`; Adjustments
Create a new contract: Creates a new contractor contract and returns it with its assigned `id`. After creation, invite the contractor to sign via `POST /contracts/{contract_id}/invitations`. **Token scopes**: `contracts:write`; Contractors
Create a new HRIS Organization Structure.: Creates a new organization structure within the HRIS, returning the created record including its assigned `id` and `organization_id`. The `is_multi_select` and `enable_roles` flags on the request body control whether the structure supports multiple team assignments and role management respectively. **Token scopes**: `organizations:write`; Organization structure
Create a New Shift Rate: Create a new shift rate with the specified attributes such as name, type, value, and a unique external identifier. **Token scopes**: `time-tracking:write`; Time Tracking Rates
Create a new task: Creates a new task for the contractor associated with the specified contract. A task can include an amount, description, and submission date. **Token scopes**: `contracts:write`; Tasks
Create a parent worker relation with external id: Sets or replaces the parent relationship for the specified HRIS profile, using external identifiers. Pass null as parent_profile_external_id to remove the existing parent relationship. **Token scopes**: `profile:write`; Worker Relations
Create a person without a contract: Adds a person record in Deel's HRIS without an associated employment contract. It creates a people-only record, allowing you to track individuals in your organization's directory before or without formalizing an employment or agreement. Suitable for pre-boarding, contingent workers, or other scenarios where a contract is not yet applicable. **Token scopes**: `people:write`; People
Create a request to exercise equity.: Submits a new equity exercise request, associating the specified option grant and stakeholder details with a worker. The request is created in a pending state; employer approval is handled as a separate operation. **Token scopes**: `contracts:write`; Contracts
Create a tax form for the authenticated worker: Submit a new US tax form for the authenticated worker against a specific client legal entity, typically during onboarding or when a fresh form must be recorded for a worker/legal-entity pair. The worker is resolved from the access token; the target legal entity is set via client_legal_entity_id. Select the form type based on the worker's US tax status: W-9 for US individuals or entities, W-8BEN for non-US individuals, W-8BEN-E for non-US entities. The worker must have an active (non-terminated) contract with the legal entity, and only one tax form may exist per worker/legal-entity pair. **Token scopes**: `worker:write`; Workers
Create a timesheet entry: Creates a timesheet entry for an hourly contractor, recording the contract, date, hours worked, and an optional description. The entry is immediately placed into a review workflow upon creation. **Token scopes**: `timesheets:write`; Timesheets
Create ATS Application: Creates a new ATS application linking an existing candidate to an existing job. Both the candidate and job must exist prior to this call; the returned id can be used for subsequent operations such as adding notes or associating interview stages. **Token scopes**: `ats:write`; ATS
Create ATS Candidate: Creates a new candidate record in the ATS and returns the candidate with their unique identifier, which can then be used to link the candidate to job applications. **Token scopes**: `ats:write`; ATS
Create ATS Job: Creates a new job in the ATS and returns the resulting job record, including its assigned `id`, initial status, and associated approval rule and request identifiers. **Token scopes**: `ats:write`; ATS
Create a worker relation: Establishes a hierarchical relationship between a worker and one or more subordinates. The request body must identify both the parent worker and the subordinate profiles to be linked. **Token scopes**: `profile:write`; Worker Relations
Create candidate tags: Replaces all existing tags on a candidate with the provided set of `tag_ids`. This is a full replacement — any tags not included in the request body will be removed. **Token scopes**: `ats:write`; ATS
Create a session token for a child organisation: Issues a short-lived session token (valid 6 hours) for a child organisation. If an active session token with more than one hour of remaining validity already exists, that token is returned. Otherwise the prior session token is invalidated and a new 6-hour token is issued. Session tokens do not affect the child organisation’s original permanent token. **Token scopes**: `organizations:write`; Organizations
Create child organization: Creates a child organization linked to the authenticated (parent) organization, provisioning a scoped API token, a default group, the parent–child hierarchy, and an initial user assignment in a single operation. The `token` in the response is the only time the child organization's API token is returned and must be stored by the caller. **Token scopes**: `organizations:write`; Organizations
Create child worker relation: Replaces all child relationships of a given type for the specified HRIS profile. Any existing child relationships of that type not included in the request will be removed. **Token scopes**: `profile:write`; Worker Relations
Create a consent token: Generates a time-bounded consent token used to authorize third-party service connections on behalf of an organization. The token expires at the time indicated by `expires_at` in the response.; Consent
Create EOR Worker: Creates an EOR worker record and returns the associated `user_id`, `profile_id`, and `hris_profile_id`. **Token scopes**: `people:write`; EOR
Create equity or token tax event: Submits an equity or token tax event for an EOR worker enrolled in Equity & Token Services. **Token scopes**: `equities:write`; Equity Tokens
Create a group: Creates a new group within the organization and returns the created group record, including its assigned `id`. **Token scopes**: `groups:read`, `groups:write`; Groups
Create Hourly Report Preset: Creates a new hourly report preset, returning the assigned id upon success. **Token scopes**: `timesheets:write`; Projects
Create Hourly Report Root Preset: Creates a new hourly report root preset and initiates asynchronous processing; the response includes an async_task object that can be used to track completion. **Token scopes**: `timesheets:write`; Projects
Create IC invoicing tax: Creates an invoicing tax entry for an independent contractor contract. **Token scopes**: `invoice-adjustments:write`; IC invoicing taxes
Create a new legal entity: Creates a new legal entity under the organization and returns the entity record including its assigned id. **Token scopes**: `legal-entity:write`, `legal-entity:read`; Legal Entities
Create magic link: Generates a time-limited magic link for password-free worker authentication. The link and its expiry timestamp are returned in the response. **Token scopes**: `worker:read`; EOR
Create a Manager: Creates a new manager in the organization and returns the created manager's identity fields, including the assigned `id`. **Token scopes**: `organizations:write`; Managers
Create manual verification screening: Creates a manual identity verification submission as a fallback when automated verification has failed multiple times or when the document's country of issue is not supported by the automated solution. **Token scopes**: `worker:write`; Screenings
Create a Milestone: Creates a new payment milestone on a milestone-based contract. After creation, the milestone enters a review workflow before payment is processed. **Token scopes**: `milestones:write`; Milestones
Create On-Demand Payroll: Creates an On-Demand Payroll for the given contract from existing eligible entries and/or a salary advance amount. **Token scopes**: `on-demand-payroll:write`; On-Demand Payroll
Create organization custom role.: Creates a new custom role within the current organization. **Token scopes**: `organizations:write`; Organizations
Create and pay a payment statement: 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. Returns the composed statement once payment has been initiated. **Token scopes**: `payment-statements:write`; Payments
Create raw time tracking shifts: Create raw shifts for the specified contract ID. “Raw shifts” refers to uncategorized entries—simply submit the clock-in and clock-out times. The classification of those hours (e.g., regular or overtime) will be handled by the Deel platform. **Token scopes**: `time-tracking:write`; Time Tracking Shifts
Create shifts: Creates multiple time tracking shifts for a contract, supporting both regular shift submissions and corrections that adjust hours for previously processed shifts. **Token scopes**: `time-tracking:write`; Time Tracking Shifts
Create time-off request: Creates a new time-off request for a worker. **Token scopes**: `time-off:write`, `worker:write`; Time Off
Review a single timesheet: Submits an approve or reject decision for a timesheet entry. Approved timesheets are queued for inclusion in the next payment cycle. **Token scopes**: `timesheets:write`; Timesheets
Create Vendor Bill: Creates a new vendor bill in accounts payable, associating it with your organization. Attachments can be added to the bill via a subsequent call using the returned id. **Token scopes**: `treasury-vendorbill:write`; Treasury
Create Veriff session: Initiates an identity verification session via Veriff, returning a URL to which the worker must be redirected to complete the verification flow. **Token scopes**: `screenings:write`, `worker:write`; Screenings
Create a webhook: Creates a new webhook subscription with the specified URL, events, and configuration. Returns the created webhook, including its signing key for verifying incoming event payloads. **Token scopes**: `webhooks:write`; Webhooks
Create worker access token: Issues a scoped access token granting a worker access to worker-side API endpoints. The response includes the token value and its expiry timestamp. **Token scopes**: `admin:worker`; Worker Session
Create worker relation with external Ids: Creates a hierarchical worker relation between a worker and their subordinates, using external IDs to identify all parties. The request body must supply the external IDs of both the parent and child workers along with the relation type. **Token scopes**: `profile:write`; Worker Relations
Create worker relation type: Creates a new worker relation type, defining a named parent–child relationship structure that can be applied to worker associations. The `is_default` flag on the response indicates whether the created type has been set as the default relation type. **Token scopes**: `organizations:write`; Worker Relations
Create a new worker: Creates a new worker record and returns the associated user_id, profile_id, and contract_id for the created worker.; Workers
Delay EOR employee onboarding: Defers the scheduled onboarding start date for the EOR employee on the specified contract. **Token scopes**: `contracts:write`; EOR
Delete an adjustment: Permanently deletes an adjustment by its id. **Token scopes**: `adjustments:write`; Adjustments
Delete an Org Structure from the Organization: Delete an Org Structure from the Organization. Use the force flag to bypass validation checks and remove the structure even when profiles are still assigned to it. **Token scopes**: `organizations:write`; Organization structure
Delete a Shift Rate by external ID: Deletes a shift rate identified by its external_id, which is the custom identifier assigned at creation time. Deletion is blocked if the shift rate is currently associated with any active shift. **Token scopes**: `time-tracking:write`; Time Tracking Rates
Delete a worker relation type: Deletes an existing worker relationship type. **Token scopes**: `organizations:write`; Worker Relations
Delete Bank Details: Permanently removes the bank payout method identified by the given method `id`. **Token scopes**: `worker:read`, `worker:write`; Payouts
Delete Contract custom field by Id: Clears the value of a custom field on the specified contract, identified by the custom field `id`. **Token scopes**: `contracts:write`; Custom Fields
Delete task: Deletes a specific task from a contract. An optional `reason` can be supplied for audit or documentation purposes. **Token scopes**: `contracts:write`; Tasks
Delete Contract Termination Request: Cancels a pending termination request for the specified contract, reverting the contract to its pre-termination state. Only termination requests that have not yet reached their effective date can be cancelled. **Token scopes**: `contracts:write`; Terminations
Delete the custom field value from Worker by Id: Removes a specific custom field value from a worker record by the custom field's ID. **Token scopes**: `people:write`; Custom Fields
Delete a group: Soft-deletes a group by archiving it. The group is not permanently removed and the response includes the `archived_at` timestamp reflecting when the archive occurred. **Token scopes**: `groups:write`; Groups
Delete Hourly Report Preset: Permanently deletes an hourly report preset identified by id. **Token scopes**: `timesheets:write`; Projects
Delete IC invoicing tax: Permanently removes the specified `tax_type` from the contract's invoicing tax configuration; this action is irreversible and takes effect on future invoices. **Token scopes**: `invoice-adjustments:write`; IC invoicing taxes
Delete adjustment: Permanently removes an invoice adjustment by its `id`. **Token scopes**: `invoice-adjustments:write`; Invoices
Delete a legal entity: Archives the legal entity identified by id, marking it as inactive without permanently removing it; the response includes the archived_at timestamp. **Token scopes**: `legal-entity:read`, `legal-entity:write`; Legal Entities
Delete a Milestone: Permanently deletes a specific milestone from a contract. This operation is irreversible and removes all associated milestone data. **Token scopes**: `milestones:write`; Milestones
Delete multiple shifts by External ID: This endpoint deletes shifts using external IDs. Once deleted, the shifts will no longer be retrievable or editable. **Token scopes**: `time-tracking:write`; Time Tracking Shifts
Delete an Org Structure from the Organization by external ID: Permanently removes an organization structure from the organization. **Token scopes**: `organizations:write`; Organization structure
Delete a Shift by External ID: Permanently deletes a shift identified by its external_id. Once deleted, the shift cannot be retrieved or modified. **Token scopes**: `time-tracking:write`; Time Tracking Shifts
Delete a timesheet entry: Permanently deletes a timesheet entry. An optional `reason` query parameter may be provided to record the rationale for deletion. **Token scopes**: `timesheets:write`; Timesheets
Delete a webhook: Permanently deletes the specified webhook subscription by its unique identifier. This action cannot be undone. **Token scopes**: `webhooks:write`; Webhooks
Delete worker access token: Immediately revokes the active access token for the worker identified by worker_id, terminating all API access granted by that token. **Token scopes**: `admin:worker`; Worker Session
Delete a worker relation by external id: Removes the worker relation identified by the given external ID. This operation removes all hierarchical associations (parent and child) linked to that relation. **Token scopes**: `profile:write`; Worker Relations
Delete a worker relation type by external id: Permanently deletes the worker relation type. **Token scopes**: `organizations:write`; Worker Relations
Delete a worker relation: Removes the worker relation. This operation removes all hierarchical associations (parent and child) linked to that profile. **Token scopes**: `profile:write`; Worker Relations
Detach entries from On-Demand Payroll: Detaches entries from an On-Demand Payroll, keeping or removing the specified entries before the ODP is submitted. **Token scopes**: `on-demand-payroll:write`; On-Demand Payroll
Download a GP worker payslip: Returns a pre-signed download URL for a specific Global Payroll (GP) employee payslip PDF. Use this after calling Retrieve employee payslips to obtain the payslipId. Requires the worker id (UUID) and the payslipId from the list response. The returned URL is temporary and should be used promptly to download the file. Supports only GP contract types. **Token scopes**: `payslips:read`, `worker:read`; Global Payroll
Download employee agreement PDF: Returns a time-limited download URL for the employee agreement PDF associated with the given `contract_id`. When the optional `version` parameter is supplied and a version mismatch is detected, behaviour diverges from the default resolution path. **Token scopes**: `worker:read`; EOR
Download employee compliance document template: Returns a time-limited download URL for the compliance document template associated with the given `document_id`, only if a template exists for that document. **Token scopes**: `worker:read`; EOR
Download gross to net report: Downloads the gross-to-net calculation report for the specified payroll report as a CSV file, with optional currency conversion applied. **Token scopes**: `global-payroll:read`; Global Payroll
Download HRX documents: Generates a pre-signed URL for downloading a specific HRX document as a PDF associated with an EOR contract. The URL expires 15 minutes after generation. **Token scopes**: `contracts:read`, `worker:read`; HRX Documents
Download submitted compliance document: Returns a time-limited download URL for a submitted compliance document. The URL expires at the time indicated by `expires_at` in the response. **Token scopes**: `worker:read`; EOR
Dynamic Requirements: Returns the progressive field requirements needed to configure a bank transfer payout method, based on the data provided in the request. The `is_final` flag in the response indicates whether all requirements have been satisfied; callers should continue submitting updated data until `is_final` is `true` before calling `POST /payouts/employees/methods`. **Token scopes**: `worker:read`, `worker:write`; Payouts
Edit a legal entity: Applies a partial update to an existing legal entity identified by id; only fields included in the request body are modified. **Token scopes**: `legal-entity:write`; Legal Entities
Edit a group: Applies a partial update to an existing group's details. Only fields included in the request body are modified; omitted fields retain their current values. **Token scopes**: `groups:read`, `groups:write`; Groups
Employee additional info template: Returns the additional information template for a given contract type and employment country, specifying the fields required to complete employee information for that combination. **Token scopes**: `contracts:read`; Employee Information
Request EOR Contract Resignation: Submits a resignation request for an EOR contract on behalf of a team member. Callers must hold group admin or people manager permissions. **Token scopes**: `contracts:read`, `contracts:write`; EOR
Termination Request: Submits a termination request for an EOR contract on behalf of a team member. Callers must hold group admin or people manager permissions. **Token scopes**: `contracts:read`, `contracts:write`; EOR
Process time-off requests from an external HRIS: Synchronizes time-off requests from an external HRIS into Deel for Global Payroll contracts only. Each record is upserted or deleted based on its external ID — records carrying `deleted: true` are removed while all others are inserted or updated — and Deel calculates the payroll cycle impact of each operation. **Token scopes**: `time-off:write`; Time Off
Fetch all payout methods: Returns all payout methods associated with the authenticated account, with optional filtering to return only the default method. **Token scopes**: `worker:read`, `worker:write`; Payouts
Fetch an Org Structure from the Organization: Fetches a single organization structure, returning associated roles and teams alongside structure metadata. **Token scopes**: `organizations:read`; Organization structure
Fetch EOR contract document: Returns a specific document as a PDF for a given EOR contract. Currently only the `FRAMEWORK_AGREEMENT` document type is supported. **Token scopes**: `contracts:read`; EOR
Fetch EOR contract documents: Returns all documents associated with a specific EOR contract. **Token scopes**: `contracts:read`; EOR
Fetch EOR Contract form: Retrieves the versioned form definition for creating an EOR contract in the specified country, including fields, validation rules, and conditional logic. The `state` parameter is only required for countries that mandate it. **Token scopes**: `forms:read`; Forms
Fetch EOR project assignment PDF: Returns the project assignment PDF for an EOR contract pending client approval. The optional version parameter allows callers to confirm the retrieved document matches an expected version before proceeding with acceptance. **Token scopes**: `contracts:read`; EOR
Fetch HrisPositions from a HrisProfile: Retrieves all positions assigned to a given HRIS profile, including the associated role, team, and organization structure for each position. **Token scopes**: `profile:read`; Positions
Fetch multiple EOR Contract forms: Retrieves paginated, versioned form definitions for creating EOR contracts across one or more specified countries. Always use the latest effective version from the response and handle pagination; this endpoint is not intended for reading or updating existing contracts. **Token scopes**: `forms:read`; Forms
Fetch Project Assignment Checkin Questionnaire Data: Returns the checkin questionnaire for a project assignment, including all sections and questions required for completion. The optional version parameter ensures the fetched questionnaire matches an expected version before it is rendered or submitted. **Token scopes**: `contracts:read`; EOR
Fetch Start Date for EOR Contracts: Returns the earliest allowed start date for a new EOR contract quote based on the specified employment country, nationality, and visa requirements. The response also includes payroll timing parameters — `start_date_buffer`, `first_payroll_lock`, and `is_same_month_payment_country` — that govern when the contract can take effect. **Token scopes**: `contracts:read`; EOR
Fetch Worker Relations of a given HrisProfile by external id: Retrieves all worker relationships for a given HRIS profile identified by its external identifier, including parent and child relationships. **Token scopes**: `profile:read`; Worker Relations
Generate magic link for manager login: Generates a single-use magic link that authenticates a manager into the platform without credentials. The target manager must belong to the requesting organization and cannot be an organization admin; this operation is restricted to White Label–enabled organizations, Partners, and Child organizations. The link expires 5 minutes after creation. **Token scopes**: `auth:write`; Managers
Generate timesheet upload url: Accepts timesheet file metadata and returns a pre-signed `upload_url` together with a new timesheet record `id`. Currently limited to EOR contracts. **Token scopes**: `time-tracking:write`; Time Tracking Timesheets
Get additional information required to request employee termination: Returns country-specific mandatory and optional questions, and identifies required supporting documents, that must be provided when initiating the offboarding process for a contract. **Token scopes**: `contracts:read`; EOR
Get Organization Structure: Returns the organization's hierarchical structure, including departments and teams, with offset-based pagination. **Token scopes**: `organizations:read`; Organization structure
List of worker relations: Returns all worker relations associated with the HrisProfile, including both parent and child relationships. **Token scopes**: `profile:read`; Worker Relations
List webhook event types: Returns all available webhook event types that can be subscribed to. Each entry includes the event name, description, and a payload example. **Token scopes**: `webhooks:read`; Webhooks
List webhooks: Returns all webhook subscriptions configured for the organization, including their current status, endpoint URLs, and subscribed events. **Token scopes**: `webhooks:read`; Webhooks
Get amendment data points configuration by country: Returns amendment data points configuration per country. If no countries filter is provided, returns configuration for all available countries. If no configuration exists for a country, all data points are treated as enabled. **Token scopes**: `contracts:read`; EOR
Get amendment validation settings for an EOR contract: Returns the validation settings for all available amendment data points on an EOR contract, optionally scoped to a specific employment state. Use these settings to determine which fields are editable and what constraints apply before constructing an amendment request. **Token scopes**: `contracts:read`; EOR
Get Bank Details: Retrieves the configured bank payout methods for an employee. **Token scopes**: `worker:read`, `worker:write`; Payouts
Get bank transfer requirements: Returns the field requirements for creating a bank transfer method for the specified country and currency combination, including fee information calculated against the provided amount or a default of 100.00. **Token scopes**: `worker:read`; Payouts
Get bank transfer supported routes for contractor: Returns all bank transfer routes available to the authenticated contractor. **Token scopes**: `worker:read`, `worker:write`; Payouts
Download invoice PDF: Returns a temporary download URL for an invoice PDF; the URL expires at the time indicated by `expires_at` in the response. **Token scopes**: `accounting:read`; Accounting
Get business visa eligibility and requirements: Analyzes a traveller's nationality, residence country, destination, and trip dates to return the available business visa options along with their fees, estimated timelines, and qualification criteria. An optional `second_nationality` may be provided to expand eligibility assessment. **Token scopes**: `immigration:read`; Immigration
Retrieve contract templates: Returns all contract templates available to the organization, including fixed-rate, pay-as-you-go, and milestone-based types. Template identifiers returned here can be supplied when creating new contracts. **Token scopes**: `contracts:read`; Contracts
Get cost centers by legal entity: Returns all cost centers associated with the specified legal_entity_id. **Token scopes**: `legal-entity:read`; Cost Centers
Get custom field from people by id: "Retrieves a single person custom field definition by its `id`. **Token scopes**: `people:read`; Custom Fields
Get custom fields from contracts: Retrieves a single custom field definition from a contract by its `id`, returning the field's name, type, settings, placement, and description. **Token scopes**: `contracts:read`; Custom Fields
Retrieve Departments: Returns the list of departments within the authenticated user's organization, including each department's identifier, name, and parent department where applicable. **Token scopes**: `organizations:read`; Organizations
Get employee agreement draft preview: Initiates or polls for async generation of an employee agreement template PDF draft. On first call (no task_id), kicks off generation and returns a task_id with is_processing: true. Poll with ?task_id=<value> until is_processing is false, at which point url contains a signed download link valid for 15 minutes. **Token scopes**: `contracts:read`; EOR
Get EOR Additional Costs: Returns the allowances and non-statutory additional costs available for inclusion in an EOR contract quote for the specified country. **Token scopes**: `contracts:read`; EOR
Get EOR Contract Amendment PDF Download Link for Client and Employee: Generates a secure, time-limited download URL for the PDF of a specific EOR contract amendment. The returned URL is valid for 15 minutes from the time of generation. **Token scopes**: `contracts:read`; EOR
Retrieve detailed hiring guide for a country: Returns country-specific hiring guide data — including salary requirements, holidays, probation terms, health insurance, and currency — for use in creating and validating EOR contract quotes. **Token scopes**: `contracts:read`; EOR
Get list of payslips for an EOR employee: Returns all payslips for an EOR employee. **Token scopes**: `worker:read`; Deel As a Service
Get termination: Returns termination data for the specified contract and termination record. Requires viewer permissions. **Token scopes**: `contracts:read`; EOR
Retrieve bank account guide: Returns the bank account form guide for an EOR employee, providing the field structure required to add a new bank account. **Token scopes**: `worker:read`; EOR
Retrieve Benefits for EOR Contract: Returns benefits associated with the specified EOR contract. **Token scopes**: `contracts:read`; EOR
Retrieve payslip PDF download link: Returns a URL for downloading the specified payslip as a PDF. **Token scopes**: `payslips:read`; EOR
Retrieve bank accounts: Returns all bank accounts associated with the employee. **Token scopes**: `people:read`; Global Payroll
Retrieve bank guide: Returns the country-specific field requirements for a worker's bank account form, which determines the fields required when adding a bank account. **Token scopes**: `people:read`; Global Payroll
Return list of groups: Returns a paginated list of groups in the organization. Archived groups are included by default and can be excluded via the `include_archived_groups` parameter. **Token scopes**: `groups:read`; Groups
Get Hourly Report Preset by ID: Retrieves a single hourly report preset by its id. **Token scopes**: `timesheets:read`; Projects
Get Hourly Report Presets: Returns saved hourly report presets for the specified contract, optionally scoped to a work statement. Results support cursor-based pagination and can be ordered by title or creation date. **Token scopes**: `timesheets:read`; Projects
Get Hourly Report Root Preset by ID: Retrieves a single hourly report root preset by its id, including its current status. **Token scopes**: `timesheets:read`; Projects
Get Hourly Report Root Presets: Returns a cursor-paginated list of hourly report root presets, with optional filtering by work_statement_statuses and result ordering. **Token scopes**: `timesheets:read`; Projects
Fetch an Org Structure from the Organization: Retrieves detailed information about a specific organizational structure including its teams and roles. **Token scopes**: `organizations:read`; Organization structure
Get HRX manager for worker: Retrieves the Human Resource Experience (HRX) Manager assigned to the authenticated worker, including contact details and a scheduling URL. Accessible only to workers with the appropriate permissions. **Token scopes**: `worker:read`; Worker HR
Get IC invoicing taxes: Retrieves the VAT and withholding tax settings configured for an independent contractor contract. **Token scopes**: `invoice-adjustments:read`; IC invoicing taxes
Get immigration case details: Retrieves the details of an immigration case by its case ID. **Token scopes**: `immigration:read`; Immigration
Get integration consent: Retrieves the OAuth consent record for the authenticated user or organization, including its current status, granted scope, and expiry.; Integrations
Get invoice by id: Retrieves the details of a single invoice by `invoice_id`. **Token scopes**: `accounting:read`; Accounting
Get invoice details by ID: This endpoint retrieves invoice information by ID. Use it to access detailed invoice data for reference or verification. **Token scopes**: `worker:read`; Workers
Get Knowledge Hub Country Guides by Country Code: Returns country guides segmented by audience and contract type for the specified `country_code`. **Token scopes**: `knowledge-hub:read`; Knowledge Hub
Retrieve lookup information for currencies, countries, entity types, etc: Returns reference data of the type specified by the `documents` query parameter; supported values are `currencies`, `countries`, `entity_types`, and `sic`. **Token scopes**: `legal-entity:read`; Lookups
Retrieve List of Managers: Returns a paginated list of all managers in the organization. **Token scopes**: `organizations:read`; Managers
Retrieve a single milestone: Retrieves a single milestone identified by milestone_id within a specific contract. **Token scopes**: `milestones:read`; Milestones
Retrieve Milestones by Contract: Retrieves all milestones associated with a specific contract, including each milestone's title, amount, status, relevant dates, and creator and reviewer information. **Token scopes**: `milestones:read`; Milestones
Get my current personal profile: Returns the profile of the currently authenticated user, including identity, organizational membership, and integration identifiers for connected services such as Slack. **Token scopes**: `worker:read`, `people:read`; People
Retrieve a single off-cycle payment: Retrieves a single off-cycle payment identified by id within a specific contract. **Token scopes**: `off-cycle-payments:read`; Off-cycle Payments
List of off-cycle payments: Retrieves all off-cycle payments for a specified contract. Off-cycle payments represent payments made outside the regular payment schedule, such as exceptional or one-time expenses. **Token scopes**: `off-cycle-payments:read`; Off-cycle Payments
Get onboarding details by employee HRIS profile ID: Returns a worker's onboarding status by `hris_profile_id`. **Token scopes**: `contracts:read`, `people:read`; Onboarding
Get onboarding details by onboarding tracker ID: Returns a worker's onboarding status by `tracker_id`. **Token scopes**: `contracts:read`, `people:read`; Onboarding
Get Current Organization: Returns details of the organization associated with the authentication token; the organization is resolved automatically from the token and requires no additional identifier. **Token scopes**: `organizations:read`; Organizations
Retrieve a payment statement: Retrieves a payment statement by its id, including its status, amounts, beneficiary details, and the authoritative list of settled invoices. **Token scopes**: `payment-statements:read`; Payments
Get personal information by id: Returns personal information for a worker by their worker ID. **Token scopes**: `people:read`; People
Get Profile Entitlements: Returns time-off entitlements for the specified hris_profile_id, including available balances, used days, and remaining allocation per time-off type. Results can be scoped to a specific policy type or tracking period date. **Token scopes**: `time-off:read`; Time Off
Get shift details: Retrieves the details of a specific shift. **Token scopes**: `time-tracking:read`; Time Tracking Shifts
Get specific immigration case details: Get detailed information for a specific immigration case. Use this to check case status and track process progress. The id path parameter is the case UUID returned from the 'Create Client Case' endpoint. Response is enriched with applicant profile, visa type, case status, estimated completion date, process details, and compliance document details. **Token scopes**: `worker:read`; Immigration
Get Team List: Returns the list of teams within the authenticated user's organization, with each entry including the team's ID and name. **Token scopes**: `organizations:read`; Organizations
Get the auto-withdrawal setting: Returns the current auto-withdrawal configuration for the authenticated worker, including whether auto-withdrawal is enabled and the identifier of the selected withdrawal method. **Token scopes**: `worker:read`; Payouts
Get the roles of the current organization.: Retrieves all roles defined within the current organization. **Token scopes**: `organizations:read`; Organizations
Get time-off attachment download URL: Returns a short-lived presigned URL to download a time-off attachment. The attachment_id is the id field returned in the attachments array of time-off responses. **Token scopes**: `time-off:read`; Time Off
Get Time Off Events for Profile: Returns time-off events for a worker profile identified by hris_profile_id, with optional filtering by time_off_type_id or policy_id. **Token scopes**: `time-off:read`; Time Off
Retrieve a single timesheet entry: Returns a single timesheet entry. **Token scopes**: `timesheets:read`; Timesheets
List of timesheets by contract: Returns timesheets associated with the specified contract, with optional filtering by contract type, status, reporter, and date range. **Token scopes**: `timesheets:read`; Timesheets
Get verification method: Returns the KYC verification method supported for a given combination of issuing country and document type. **Token scopes**: `screenings:read`, `worker:read`; Screenings
Retrieve a single webhook: Retrieve a single webhook subscription. **Token scopes**: `webhooks:read`; Webhooks
Get Work Schedule and Holidays: Returns holidays, work schedule entries, and time-off dailies for a given date range, scoped to one or more HRIS profile IDs or countries. **Token scopes**: `time-off:read`; Time Off
Get worker additional fields for (EOR): Retrieves the additional form fields required when onboarding EOR workers in the specified country. **Token scopes**: `forms:read`; Forms
Get worker invite link: Retrieves the signing invitation link generated for the worker on a contract, with optional localization via the `locale` parameter. **Token scopes**: `contracts:read`; Contracts
Get worker profile by external ID: Retrieves a worker profile record using a system-wide external worker identifier. **Token scopes**: `people:read`; People
Get worker's KYC details: Retrieves KYC verification details for a worker identified by `worker_profile_id` or `profile_id`; these two parameters are mutually exclusive. `contract_id` is required when multiple profiles are associated with the worker. **Token scopes**: `screenings:read`; Screenings
Gets G2N report data for a given payroll cycle by it's ID.: Returns categorized gross-to-net data — including category group, category, sub-category, and label — for each contract within the payroll cycle identified by `cycle_id`. **Token scopes**: `payslips:read`; Reports
/ic/workers/invoices/:invoice_id/pdf: This endpoint provides embedded worker flows access to download a pdf of a specific invoice while using a worker:PAT token. **Token scopes**: `accounting:read`; Workers
Immigration document: Retrieves the details of an immigration case document by its document `id`. **Token scopes**: `immigration:read`; Immigration
Immigration visa types: Returns the visa types supported for immigration processing in a country, identified by its Alpha-2 country code. **Token scopes**: `immigration:read`; Immigration
Initiate EOR contract termination request: Initiates a termination request for an EOR contract, beginning the offboarding process for the employee associated with the specified contract_id. The response captures the desired and confirmed end dates along with any termination documents generated at the time of the request. **Token scopes**: `contracts:write`; EOR
Send contract to worker: Sends a signing invitation email to a worker for the specified contract, setting their email as the expected signer. If the contract was previously rejected, resets its status back to a signing-eligible state. Can only be called if the worker has not already signed the contract. **Token scopes**: `contracts:write`; Contracts
Invoice line item by Id: Retrieves a single invoice line item by its `id`. **Token scopes**: `invoice-adjustments:read`, `worker:read`; Invoices
Invoice line items by contract: Retrieves invoice line items (adjustments) associated with a given contract_id, with support for filtering by contract type, adjustment type, status, invoice, reporter, and submission date range. **Token scopes**: `invoice-adjustments:read`; Invoices
Job titles list: Returns the platform's catalogue of predefined job titles. Results are paginated using cursor-based navigation via `after_cursor`.; Lookups
List all amendments for an EOR contract: Retrieves all amendments associated with a given EOR contract, including each amendment's type, effective date, and current status, providing a full history of changes applied to the contract. **Token scopes**: `contracts:read`; EOR
List all custom fields: Returns the list of custom field definitions configured for contracts within the organization. The response includes field metadata, not specific contract field values. It provides definitions with contract placement for supported types such as text, list, multiselect, number, percentage, currency, and date. **Token scopes**: `contracts:read`; Custom Fields
List all industry subcategories: Lists industry subcategories with their parent category details and NAICS codes, supporting cursor-based pagination and sorting by category or subcategory name. **Token scopes**: `legal-entity:read`; Legal Entities
List all people custom fields: Returns the list of custom field definitions configured for people within the organization. The response includes field metadata, not specific person field values. It provides definitions with people placement for supported types such as text, list, multiselect, number, percentage, currency, and date. **Token scopes**: `people:read`; Custom Fields
List feedbacks for an application: Returns a paginated list of feedbacks submitted for activities on the given application, including reviewer profiles, overall recommendations, and form responses. **Token scopes**: `ats:read`, `worker:read`; ATS
List contract amendments: Retrieves the paginated list of amendments associated with a given contract, with optional filtering by amendment status and sign status. **Token scopes**: `contracts:read`, `contracts:write`; Contracts
List contract termination reasons: Retrieves the standardized list of termination reasons to present when initiating a contract termination **Token scopes**: `contracts:read`; Contracts
List Contractor Balances: Returns the total available balances for the authenticated contractor, broken down by currency and aggregated into a single cross-currency total. **Token scopes**: `worker:read`; Payouts
List gross-to-net report.: Returns paginated gross-to-net calculation records for the specified payroll report, with optional currency conversion applied to the results. **Token scopes**: `global-payroll:read`; Global Payroll
List HR verification letters and documents: Returns all HR verification letters and documents associated with the employee contract. **Token scopes**: `worker:read`; EOR
List interviews: Returns a paginated list of interviews for the organization. **Token scopes**: `ats:read`; ATS
List invoice adjustments: Returns invoice adjustments, optionally filtered by contract, adjustment type, status, invoice, reporter, or submission date range. **Token scopes**: `invoice-adjustments:read`; Invoices
List IT assets: Returns a cursor-paginated list of all IT assets historically or currently managed by the organization. **Token scopes**: `it-assets:read`; IT assets
List IT hardware policies: Returns all available IT hardware policies, which define the equipment eligible for ordering. **Token scopes**: `it-policies:read`; IT policies
List IT orders: Returns a cursor-paginated list of all IT equipment orders for the organization, spanning both historical and current procurement requests. **Token scopes**: `it-orders:read`; IT orders
List of contracts: Returns a paginated list of contract summaries for the organization, with optional filtering by status, type, team, country, currency, external ID, or a name search term. Use `GET /contracts/{contract_id}` to retrieve full details for a specific contract. **Token scopes**: `contracts:read`; Contracts
List of employee compliance documents: Returns the list of compliance documents associated with an EOR employee. **Token scopes**: `worker:read`; EOR
List of immigration cases for workers: Retrieves a paginated list of immigration cases with filters for applicant name, case type, status, and country. Returns case details including type, status, process, timestamps, and optional closure information. **Token scopes**: `worker:read`; Immigration
List of immigration cases: Returns a paginated list of immigration cases, optionally filtered by applicant name or code, case type, status, and country (ISO 3166-1 alpha-2). Use the `cursor` value from each response to retrieve the next page of results. **Token scopes**: `immigration:read`; Immigration
List of job scope templates for EOR contracts: Returns predefined and custom job scope templates available for EOR contracts, optionally filtered to templates belonging to a specific team. **Token scopes**: `organizations:read`; EOR
List of legal entities: Returns a paginated list of legal entities in the account, with optional filtering by country, entity type, global payroll flag, and archived status. **Token scopes**: `organizations:read`, `accounting:read`; Organizations
List of People: Returns a paginated list of people records in the organization. Supports filtering by search term, teams, custom fields, and other query parameters. Build people directories, sync HR data, or power search interfaces across your workforce records. **Token scopes**: `people:read`; People
List of shifts: Retrieve a paginated list of shifts with details such as start and end times, breaks, metadata, and summary metrics. Supports pagination through `limit` and `offset` query parameters and filtering by `contractId`, date range (`fromDate` and `toDate`). **Token scopes**: `time-tracking:read`; Time Tracking Shifts
List of tasks: Retrieves all tasks associated with a specific contract, including each task's ID, amount, submission date, status, and description. **Token scopes**: `contracts:read`; Tasks
List of tax documents for an employee: Returns tax documents for the authenticated worker. **Token scopes**: `worker:read`; EOR
List of timesheets: Returns a paginated list of timesheets in the account, optionally filtered by contract_id, contract_types, statuses, reporter_id, or date range. **Token scopes**: `timesheets:read`; Timesheets
List of worker compliance documents: Retrieve the list of compliance document requirements for a worker, grouped by country. Returns all required and optional documents with their current submission status. Applicable for both independent contractors and EOR employees. **Token scopes**: `worker:read`; Workers
List On-Demand Payroll entries: Lists the adjustments eligible for On-Demand Payroll for the given contract, with the contract eligibility details and limits. **Token scopes**: `on-demand-payroll:read`; On-Demand Payroll
List onboarding employees: Returns a list of workers currently going through onboarding, including contract details, HRIS profile information, current onboarding status, and onboarding due dates. Supports cursor-based pagination. **Token scopes**: `contracts:read`, `people:read`; Onboarding
List job openings: Returns all job openings (requisitions/headcount requests) for the authenticated organization. Supports filtering by status, team, location, and linked job. Results are cursor-paginated. Openings track headcount requests through a lifecycle from DRAFT to FILLED or CLOSED. **Token scopes**: `ats:read`; ATS
List organization tasks: Returns a paginated list of all tasks for the current organization, not limited to those assigned to the caller; intended for callers with the `organization.manage` permission. Supports both offset/limit and cursor-based pagination, which are mutually exclusive — do not supply `cursor` together with an offset parameter. **Token scopes**: `tasks:read`; Organization Tasks
List payroll cycles: Returns a paginated list of payroll events for the specified legal entity, optionally filtered by a date range; date_start must not be earlier than 5 years ago and date_end must not exceed 5 years in the future. **Token scopes**: `legal-entity:read`; List Cycles
List payroll events by legal entity: Retrieves payroll events associated with the specified legal entity, suitable for preparing payroll reports or auditing pay cycles. **Token scopes**: `global-payroll:read`; Global Payroll
List policies: Returns the time-off policies assigned to the specified hris_profile_id, including policy details such as allowed types, accrual rules, and balances. Results can be filtered by policy type name or policy type ID. **Token scopes**: `time-off:read`; Time Off
List tags: Returns a paginated list of tags associated with the organization, filterable by label and `tag_group_slug`; when `include_counts` is true, each tag includes a count of associated candidates. **Token scopes**: `ats:read`; ATS
List time-off requests for Organization: Returns time-off requests for the authenticated organization, with optional filtering by status, date ranges, policy types, and specific request IDs. Results are paginated using cursor-based navigation. **Token scopes**: `time-off:read`; Time Off
List time-off requests: Returns a paginated list of time-off requests for the specified hris_profile_id, with optional filters for status, policy type, date ranges covering the time-off period, approval date, and last-updated date. **Token scopes**: `time-off:read`; Time Off
Modify bank account for an EOR employee: Applies a partial update to the bank account details for an EOR employee. The request body accepts an array of field-level updates. **Token scopes**: `worker:write`; Deel As a Service
Modify bank account: Partially updates the bank account for the worker; only fields provided in the request body are modified. **Token scopes**: `people:write`; Global Payroll
Preview a contract agreement: Returns the rendered HTML content of an IC or EOR contract agreement for a given contract_id. If no templateId is provided, the default or currently assigned template is used. Global Payroll contract types are not supported. **Token scopes**: `contracts:read`, `worker:read`; Contractors
Preview job offer letter: Returns the job offer letter for an EOR contract in HTML format. IC and Global Payroll contract types are not supported and will not return a result. **Token scopes**: `worker:read`; EOR
Preview Resignation Letter: Returns a preview of the resignation letter for the EOR contract before the worker submits their signature. **Token scopes**: `worker:read`; EOR
Profiles: Applies a partial update to the authenticated user's profile, modifying only the fields supplied in the request body. **Token scopes**: `profile:write`, `profile:read`; @eng-platform-be
Reject contract: Rejects a contract identified by contract_id, provided it is currently in a pending, unsigned state. Contracts that have already been signed or previously rejected are not eligible for this operation. **Token scopes**: `worker:write`; Contracts
Request contract resignation: Initiates a resignation request for an EOR contract. **Token scopes**: `contracts:write`; EOR
Request job scope validation: Validates a job scope description and returns any validation errors. When errors are present, the response also includes a `quote_validation_log_public_id` and pre-populated `data_for_corrected_job_scope_endpoint` to support subsequent correction. **Token scopes**: `contracts:write`; EOR
Request termination: Initiates the termination process for a Global Payroll worker. A successful response confirms the request was accepted and the process has begun, but does not indicate that termination is complete. **Token scopes**: `global-payroll:write`; Global Payroll
Request to withdraw funds: Initiates a withdrawal of available funds to the employee's configured payout method. The operation is asynchronous; the outcome is delivered via webhook rather than the synchronous response. **Token scopes**: `worker:write`; Payouts
Retrieve additional information fields for GP workers by country: Retrieves the country-specific additional information fields required for GP workers to run payroll in compliance with local regulations. **Token scopes**: `forms:read`; Global Payroll
Retrieve adjustments: Retrieves all adjustments associated with a specific contract, optionally scoped to a date range. **Token scopes**: `adjustments:read`; Adjustments
Retrieve a list of ATS application sources: Returns the available application sources in the Applicant Tracking System. **Token scopes**: `ats:read`; ATS
Retrieve a list of ATS applications: Returns a cursor-paginated list of candidate applications across all open positions for the organization, with filtering by job, interview plan stage, candidate tags, source, stage type, and last-updated timestamp. **Token scopes**: `ats:read`; ATS
Retrieve a list of ATS departments: Returns a paginated list of all departments configured in the ATS. **Token scopes**: `ats:read`; ATS
Retrieve a list of ATS employment types: Returns a paginated list of employment types available in the ATS. **Token scopes**: `ats:read`; ATS
Retrieve a list of ATS job postings: Returns a paginated list of job postings belonging to the specified job board. Results can be filtered using available query parameters. **Token scopes**: `ats:read`; ATS
Retrieve a list of ATS jobs: Returns a paginated list of jobs in the ATS, filterable by text search, interview plan, locations, teams, employment types, departments, status values, and an ISO 8601 `updated_after` timestamp. **Token scopes**: `ats:read`; ATS
Retrieve a list of ATS locations: Returns a paginated list of all work locations associated with the organization, suitable for use when constructing job postings or filtering by location. **Token scopes**: `ats:read`; ATS
Retrieve a list of ATS offers: Returns all offers associated with the organization, including worker type and offer status, to support pre-onboarding and contract creation workflows. **Token scopes**: `ats:read`; ATS
Retrieve a list of published ATS email templates: Returns a paginated list of published email templates for the organization, supporting cursor-based pagination and filtering by `updated_after` timestamp. **Token scopes**: `ats:read`; ATS
Retrieve all worker relation types: Returns all configured worker relation types available in the organization, which define the valid relationship categories that can be assigned when creating or upserting worker relations. **Token scopes**: `organizations:read`; Worker Relations
Retrieve an adjustment: Retrieves a specific adjustment by its id, including its amount, status, payment cycle dates, and associated contract_id. **Token scopes**: `adjustments:read`; Adjustments
Retrieve an IT asset: Retrieves the details of a specific IT asset by `asset_id`. **Token scopes**: `it-assets:read`; IT assets
Retrieve an IT order: Returns the status, shipping details, and associated product for a single IT equipment order identified by order_id. **Token scopes**: `it-orders:read`; IT orders
Retrieve a Paginated List of Shift Rates: Retrieve a paginated list of shift rates, including details such as rate name, type, value, and timestamps. Pagination parameters can be used to control the size and position of the result set. **Token scopes**: `time-tracking:read`; Time Tracking Rates
Retrieve a payment breakdown: Returns a breakdown of a payment made to Deel, with individual invoices and the Deel fee included as discrete line items. **Token scopes**: `accounting:read`; Accounting
Retrieve a required document for a case: Retrieves the details of a specific document requirement within a worker's immigration case, including the requirement's current status and information about any previously rejected document. **Token scopes**: `worker:read`; Immigration
Retrieve a Shift Rate by External ID: Retrieves a shift rate. **Token scopes**: `time-tracking:read`; Time Tracking Rates
Retrieve a single contract: Retrieves the full record for a specific contract by `contract_id`, including status, compensation, worker details, and metadata. Pass `expand=cost_centers` or `expand=custom_fields` as a query parameter to include additional data in the response. **Token scopes**: `contracts:read`; Contracts
Retrieve a single person: Returns detailed information about a single person in the organization by their public ID. Returns personal details, employment information, organizational structure, person status, direct manager, custom fields, and related data. **Token scopes**: `people:read`; People
Retrieve a timesheet: Retrieves a timesheet by `timesheet_id`, including its submission, review, and processing status. Pass `expand=file_data` to include file name and download URL in the response. **Token scopes**: `time-tracking:read`; Time Tracking Timesheets
Retrieve ATS application: Retrieves a single application by its application_id, including associated job details, job posting details, and related metadata. **Token scopes**: `ats:read`; ATS
Retrieve ATS hiring members: Returns a paginated list of hiring members configured in the ATS. **Token scopes**: `ats:read`; ATS
Retrieve ATS job posting: Returns a single job posting by `job_posting_id`, including its associated job object, publication status, application form configuration, compensation visibility flag, and rich-text description. **Token scopes**: `ats:read`; ATS
Retrieve ATS job postings: Use this endpoint to retrieve job postings by specifying the job board ID or job ID. It provides detailed postings with job details, publication status, and relevant metadata. **Token scopes**: `ats:read`; ATS
Retrieve bank account guide: Returns the bank account form guide for the specified `country` and `currency` combination, providing the field structure required to add a new bank account for an EOR employee. **Token scopes**: `worker:read`; EOR
Retrieve Benefits by Country: Returns benefits available in a specific country, scoped by work visa requirement, weekly work hours, employment type, team, and legal entity. **Token scopes**: `benefits:read`; EOR
Retrieve Benefits for Employee: Returns the benefits for the authenticated employee. The employee identity is inferred from the auth token, so this endpoint must be called with an employee-scoped token rather than a client token. **Token scopes**: `benefits:read`; EOR
Retrieve categories: Returns the available adjustment categories, optionally filtered by contract type. Category IDs returned here are required when creating adjustments and define the type and accounting treatment applied. **Token scopes**: `adjustments:read`; Adjustments
Retrieve contract PDF download link: Returns a secure, time-limited URL for downloading the PDF version of the contract identified by contract_id. The URL is accessible only to the authenticated worker associated with that contract. **Token scopes**: `worker:read`; Contracts
Retrieve contractor payment dates: Fetches the scheduled payment dates and current status of each payment cycle for a specific contract. **Token scopes**: `contracts:read`; Contracts
Retrieve Country List: Returns all countries supported by the platform, including each country's visa support status, Employer of Record availability, sub-territories, and classification.; Lookups
Retrieve current On-Demand Payroll: Retrieves the active On-Demand Payroll for the given contract, including its status, SLAs, invoice and attached entries. **Token scopes**: `on-demand-payroll:read`; On-Demand Payroll
Retrieve custom fields for a contract: Returns all custom fields associated with the specified contract. **Token scopes**: `contracts:read`; Custom Fields
Retrieve custom fields for a worker: Returns all custom field values currently set for the specified worker. **Token scopes**: `people:read`; Custom Fields
Retrieve Deel invoices: Returns a paginated list of invoices for Deel platform fees. **Token scopes**: `accounting:read`; Accounting
Retrieve Effective Date Limitations: Returns validation rules for the effective date field within an EOR contract amendment flow. **Token scopes**: `contracts:read`; EOR
Retrieve employee payslip records: Returns a list of payslip records for the specified worker. **Token scopes**: `payslips:read`; EOR
Retrieve employee payslips: Returns the payslip history for a GP employee, including each payslip's date range and status. Restricted to GP contract types. Each payslip in the response includes an `id` required by the payslip download endpoint. **Token scopes**: `payslips:read`, `worker:read`; Global Payroll
Retrieve Employee Time Off Data for Offboarding: Returns time off entitlements, balances, and upcoming time offs for the employee on the specified contract, optionally scoped to a target end_date. The response includes policy settings and tracking configuration required to support completion of an offboarding request. **Token scopes**: `contracts:read`; EOR
Retrieve EOR Contract Details: Returns basic contract information and associated employment costs for a specific EOR contract. **Token scopes**: `contracts:read`; EOR
Retrieve HRX documents: Returns a paginated list of HRX documents shared with an employee under a specific EOR contract. **Token scopes**: `worker:read`, `contracts:read`; HRX Documents
Retrieve invoices: Returns a paginated list of invoices; by default only paid invoices are returned, but passing `status=all` returns invoices in all statuses. Supports both offset- and cursor-based pagination. **Token scopes**: `accounting:read`; Accounting
Retrieve offboarding attachment: Downloads the content of a specific attachment associated with the termination for a given contract. **Token scopes**: `contracts:read`; EOR
Retrieve offboarding list: 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 regardless of date. **Token scopes**: `contracts:read`, `people:read`; Offboarding
Retrieve Offboarding Request: Retrieves the offboarding request associated with a specific EOR contract, including termination details, document review status, offboarding request data, and pending employee notification state. **Token scopes**: `contracts:read`, `worker:read`; EOR
Retrieve onboarding right-to-work case for a worker: Returns the right-to-work onboarding case for a worker, including any associated documents; returns an empty response if no open case exists. When a worker is associated with multiple contracts, supply `contract_id` to target a specific contract. **Token scopes**: `worker:read`; Immigration
Retrieve paginated list of ATS attachment files: Lists attachment files for a specific ATS entity, scoped by `attachable_type_slug`, `attachable_id`, and `attachment_type_slug`. **Token scopes**: `ats:read`; ATS
Retrieve paginated list of ATS Candidates: Returns a paginated list of candidates, optionally filtered by job IDs, department IDs, tag IDs, current stage category or default type slugs, or a timestamp to return only records updated after a given point. **Token scopes**: `ats:read`; ATS
Retrieve paginated list of ATS Rejection/Archivation reasons: Returns a paginated list of rejection and archivation reasons, filterable by `reason_group_slug` and `subgroup_slug`; when `include_counts` is true, each reason includes a usage count. **Token scopes**: `ats:read`; ATS
Retrieve payment receipts: Returns a cursor-paginated list of payments to Deel, including worker details, payment status, and payment methods. Use the `next_cursor` value from the response to retrieve subsequent pages. **Token scopes**: `accounting:read`; Accounting
Retrieve policy validation templates: Returns policy validation templates and policy types for one or more countries, specified as ISO 3166-1 alpha-2 codes. Policy types in the response are unique across the result set. **Token scopes**: `time-off:read`; Time Off
Retrieve refund statement credit-note breakdown: Use this endpoint to retrieve a detailed breakdown of credit notes associated with a specific refund statement. It provides comprehensive details for financial tracking and reconciliation. **Token scopes**: `accounting:read`; Refund Statements
Retrieve refund statements: Use this endpoint to retrieve a list of refund statements. This allows review of past transactions and reconciliation of accounts. **Token scopes**: `accounting:read`; Accounting
Retrieve restricted offboarding dates: Returns country-specific dates unavailable for offboarding end-date selection—including weekends and public holidays—along with the earliest available end date; optionally filtered by termination type. **Token scopes**: `contracts:read`; EOR
Retrieve Seniority Levels: Returns predefined seniority levels including their names, hierarchical positions, and identifiers. When `is_eor_contract` is `true`, C-level seniorities are excluded from the response.; Lookups
Retrieve Supported Currency List: Returns all currencies supported by the platform, including their ISO codes and names.; Lookups
Retrieve termination details by HRIS profile identifier: Returns termination details for a contract identified by its HRIS profile `oid`. **Token scopes**: `contracts:read`, `people:read`; Offboarding
Retrieve termination details: Returns termination details for a contract identified by its offboarding tracker `id`. **Token scopes**: `contracts:read`, `people:read`; Offboarding
Retrieve Time-Off Types: Returns the predefined time-off types available for registration on the platform.; Lookups
Retrieve worker resignations: Returns resignations submitted by EOR workers, optionally filtered by resignation letter status. **Token scopes**: `worker:read`; EOR
Retrieve worker transaction history: Use this endpoint to access a worker's transaction history quickly. This integration works with white-label clients and ensures compliance by not following the generic contractor route **Token scopes**: `worker:read`; Workers
Retrieve worker's actionable journeys: Returns cursor-paginated ActionableJourneys assigned to the authenticated worker. ActionableJourneys correspond to what the user interface labels as Courses. Learn more about [Learning Management](https://www.deel.com/hr/engage/learning-management-software/) **Token scopes**: `worker:read`; Learning
Retrieve working locations: Returns the list of available work location labels for the organization. Populate options when creating or editing people or contract records. **Token scopes**: `organizations:read`; Organizations
Review, approve, or request changes to EOR offboarding documents: Submits a client sign-off decision—approval or change request—for the offboarding documents of a specific contract during the client sign-off step. **Token scopes**: `contracts:write`; EOR
Review a single task: Submits an approval or rejection review for a task associated with a contract. If the review status is declined, an optional reason may be included in the request body. **Token scopes**: `contracts:write`; Tasks
Review a submitted timesheet: Approves or rejects a submitted timesheet; only timesheets in `PENDING_REVIEW` status are eligible, and all associated hours are approved or rejected as a single operation. **Token scopes**: `time-tracking:write`; Time Tracking Timesheets
Review multiple tasks: Approves or declines multiple submitted tasks associated with a contract in a single request. Each task review must include a status of approved or declined, with an optional reason required when declining. **Token scopes**: `contracts:write`; Tasks
Sign a contract amendment (employee): Records the employee's signature on a specific contract amendment, confirming acceptance of the amendment terms. Returns the updated amendment record upon successful signing. **Token scopes**: `worker:write`; EOR
Sign a contract: Signs a contract on behalf of the contractor, transitioning contract status to active and completing the contractor onboarding workflow. **Token scopes**: `worker:write`; EOR
Sign Amendment: Records the worker's signature on a pending amendment identified by amendment_id. Once signed, the amendment's status change is reflected in the associated contract. **Token scopes**: `worker:read`, `worker:write`, `benefits:read`; Contracts
Sign a contract: Signs a contract on behalf of the client (employer), advancing the contract through the hiring workflow. When the contract is awaiting the client signature, it transitions to a pending-contractor-signature state. Can also be used to sign a pending amendment on an already active contract. **Token scopes**: `contracts:write`; Contracts
Sign EOR contract document: Applies a signature and job title to a specified EOR contract document. Currently only the `FRAMEWORK_AGREEMENT` document type is supported. **Token scopes**: `contracts:write`; EOR
Sign Resignation Letter: Records the worker's signature on the resignation letter for the contract, which is required to finalize the resignation process; upon successful submission, the signed letter is queued for PDF generation and further processing. **Token scopes**: `worker:write`; EOR
Sign worker contract: Records the worker's signature on the contract identified by contract_id. Only contracts in an unsigned, pending state can be signed. **Token scopes**: `worker:write`; Contracts
Submit employee resignation PTO review: Submits PTO details for a resignation request, triggers related notifications, and finalizes the PTO review step. Only callable when the resignation status is `AWAITING_PTO`. **Token scopes**: `contracts:write`; EOR
Submit employee sign-off review for offboarding documents: Records an employee's sign-off decision—approval or change request with feedback—for the offboarding document set of a contract. **Token scopes**: `worker:write`; EOR
Submit EOR Worker Resignation: Formally initiates the resignation process for the EOR contract by submitting a resignation request on behalf of the worker. **Token scopes**: `worker:write`; EOR
Submit external KYC: Submits an external KYC record that combines automated Live ID verification (IDV) with a manual review workflow to satisfy identity verification and compliance requirements. **Token scopes**: `worker:write`; Screenings
Submit On-Demand Payroll: Submits an On-Demand Payroll for Deel processing after the client has reviewed and approved all of its entries. **Token scopes**: `on-demand-payroll:write`; On-Demand Payroll
Submit Project Assignment Checkin Questionnaire Data: Submits completed answers for a project assignment checkin questionnaire. All required questionnaire fields must be included; partial submissions are not accepted. **Token scopes**: `contracts:read`, `contracts:write`; EOR
Sync cost centers for legal entity: Update legal entity cost center's data to replicate the data provided on the request **Token scopes**: `legal-entity:write`; Cost Centers
Terminate contract: Initiates termination of an active contract, recording the termination reason, effective date, and any final payment details. Can only be called on contracts that are currently active. **Token scopes**: `contracts:write`; Terminations
Remove invite: Removes the active signing invitation from a contract to allow a new invitation to be issued to the worker. **Token scopes**: `contracts:write`; Contracts
Update additional information: Partially updates the additional information on an EOR employee agreement. This operation is only permitted when the contract status is `new`, `under_review`, or `waiting_for_employee_contract`; invoking it with any other status will result in an error. **Token scopes**: `worker:write`; EOR
Update address: Partially updates the address on record for the GP employee. **Token scopes**: `people:write`; Global Payroll
Update an adjustment: Applies a partial update to an existing adjustment. Only fields included in the request body are modified; omitted fields retain their current values. **Token scopes**: `adjustments:write`; Adjustments
Update an existing HRIS Org Structure by external ID: Applies a partial update to an existing organization structure. Only fields provided in the request body are modified; omitted fields retain their current values. **Token scopes**: `organizations:write`; Organization structure
Update an existing HRIS Org Structure: Update an existing HRIS Org Structure including its name, settings, and teams hierarchy. **Token scopes**: `organizations:write`; Organization structure
Update an invoice adjustment: Applies a partial update to an existing invoice adjustment; only fields included in the request body are modified. **Token scopes**: `invoice-adjustments:write`, `worker:write`; Invoices
Update a shift rate: Applies a partial update to an existing shift rate, modifying only the fields provided in the request body. **Token scopes**: `time-tracking:write`; Time Tracking Rates
Update a shift: Applies a partial update to an existing shift, modifying only the fields supplied in the request body. Fields omitted from the request are left unchanged. **Token scopes**: `time-tracking:write`; Time Tracking Shifts
Update a specific EOR contract amendment: Applies a partial update to a specific EOR contract amendment. The amendment must be in DRAFT status; updates to amendments in any other state will be rejected. This operation overwrites existing draft data and cannot be undone. **Token scopes**: `contracts:write`; EOR
Update a timesheet entry: Partially updates an existing timesheet entry; only fields supplied in the request body are modified. Both clients and contractors may perform this operation. **Token scopes**: `timesheets:write`; Timesheets
Update auto withdraw setting for contractor: Updates the auto-withdrawal configuration for the authenticated contractor. **Token scopes**: `worker:read`, `worker:write`; Payouts
Update a bank transfer method: Fully replaces the bank transfer method; all method fields must be provided as this is a complete replacement, not a partial update. **Token scopes**: `worker:read`, `worker:write`; Payouts
Update compensation: Updates the compensation for the GP employee and returns the complete compensation history including the applied change. **Token scopes**: `people:write`; Global Payroll
Update contract payment type: Sets the payment type for an IC contract. Use `platform_payment_type_application_type` to control when the change takes effect on a signed contract. **Token scopes**: `contracts:write`; Contracts
Update Employee Information for EOR Contract: Applies partial updates to employee information on an EOR contract. Only accepts documented fields — any undocumented fields will cause a validation error. Updates are permitted only when the contract has a status of `new`, `under_review`, `waiting_for_client_sign`, `waiting_for_eor_sign`, `waiting_for_employee_contract`, `waiting_for_employee_sign`, `awaiting_deposit_payment`, or `rejected`. **Token scopes**: `contracts:write`; EOR
Update employee information: Partially updates personal details, tax information, and employment-related fields for the GP worker. **Token scopes**: `people:write`; Global Payroll
Update employment type for a contract: Update the employment type (full-time, part-time, or on leave) and FTE for a Global Payroll contract. Provide the contract ID and the change details, including the date the change takes effect. **Token scopes**: `contracts:write`; Global Payroll
Update EOR Contract: Applies partial updates to mutable fields of an EOR contract, such as salary, job title, or benefits. Only fields included in the request body are modified; fields required for validation must still be present. **Token scopes**: `contracts:write`; EOR
Update GP Workers Additional Information: Partially updates the additional information on the contract; only fields supplied under the `data` object are modified. **Token scopes**: `people:write`; Global Payroll
Update PTO policy: Applies a partial update to the PTO policy assigned to a Global Payroll worker. Only fields included in the request body are modified; omitted fields retain their current values. **Token scopes**: `people:write`; Global Payroll
Update Hourly Report Preset: Applies a partial update to an existing hourly report preset identified by id. Only fields included in the request body are modified. **Token scopes**: `timesheets:write`; Projects
Update IC invoicing tax: Applies a partial update to the invoicing tax for an independent contractor contract; accepts `tax_type` (WITHHOLDING_TAX or VAT) and `percentage` to modify how taxes are calculated on future invoices. **Token scopes**: `invoice-adjustments:write`; IC invoicing taxes
Review a single invoice adjustment: Submits an approve or decline review decision for a single invoice adjustment. **Token scopes**: `invoice-adjustments:write`; Invoices
Update organization custom role: Applies a partial update to the custom role, modifying only the fields supplied in the request body. **Token scopes**: `organizations:write`; Organizations
Update organization structure team custom fields: Applies a partial update to custom field values on the specified team. Updates can be scheduled for a future effective date, and setting a field's value to `null` deletes that field value. **Token scopes**: `organizations:read`; Organization Structure
Update organization structure: Assigns a worker to a department by their HRIS profile ID. By default the new assignment appends to existing positions; set `replace_other_positions` to true to replace all current positions instead. **Token scopes**: `people:write`; People
Update personal information by external id: Partially updates a worker's personal information using an external identifier. Only fields included in the request body are modified. **Token scopes**: `people:write`; People
Update personal information: Partially updates personal information for a worker by their worker ID; only fields included in the request body are modified. **Token scopes**: `people:write`; People
Update working location: Sets the working location for a worker identified by their HRIS profile ID. **Token scopes**: `people:write`; People
Update Task By ID: Applies a partial update to the specified task and returns whether the update was successful. **Token scopes**: `tasks:write`; Tasks
Update time-off request: Corrects details of an existing time-off request, such as its dates, amount, reason, or time-off type, without requiring the worker to cancel and resubmit it. Applies a partial update identified by time_off_id; only fields included in the request body are modified. **Token scopes**: `time-off:write`, `worker:write`; Time Off
Update a webhook: Partially updates an existing webhook subscription. Supports updating fields such as status and child organization event propagation. **Token scopes**: `webhooks:write`; Webhooks
Update a worker relation type by external id: Applies a partial update to a worker relation type. Only fields included in the request body are modified; omitted fields retain their current values. **Token scopes**: `organizations:write`; Worker Relations
Update a worker relation type: Applies a partial update to an existing worker relation type. Only fields provided in the request body are modified; omitted fields retain their current values. **Token scopes**: `organizations:write`; Worker Relations
Upload a required immigration document: Uploads a document against a specific case document requirement and submits it for review. **Token scopes**: `worker:write`; Immigration
Upload employee compliance document: Uploads a compliance document file against the specified `document_id` for an EOR employee. **Token scopes**: `worker:write`; EOR
Upload Vendor Bill Attachment: Attaches a PDF invoice file to an existing vendor bill, submitted as multipart/form-data. The target bill must already exist before this call is made. **Token scopes**: `treasury-vendorbill:write`; Treasury
Create child worker relation with external Id: Creates or replaces the child worker relation for the HrisProfile identified by the given external ID. If a child relation already exists for this profile, it is overwritten with the supplied data. **Token scopes**: `profile:write`; Worker Relations
Update custom field value: Creates or updates custom field values on the specified contract. This is a full replacement operation — any custom field values not included in the request body will be removed. **Token scopes**: `contracts:write`; Custom Fields
Update custom field value: Creates or updates a custom field value for a worker; if a value for the specified field already exists it is overwritten. **Token scopes**: `people:write`; Custom Fields
Create a parent worker relation: Creates or replaces the parent worker relation for the HrisProfile. If a parent relation already exists for this profile, it is overwritten with the supplied data. **Token scopes**: `profile:write`; Worker Relations
Validate amendment data points: Validates amendment data points for a given contract against any external validation rules before an amendment is submitted. This call should be made prior to creating an amendment to confirm that the proposed data points are acceptable. **Token scopes**: `contracts:write`; EOR
Validate time-off request: Validates a time-off request against policy compliance, available balance, blackout dates, and other rules before the request is created. The response includes an is_valid flag, any validation error message, adjusted start and end dates if applicable, balance projections, and country-specific validation results. **Token scopes**: `time-off:read`; Time Off
View information about amendment: Retrieves a specific amendment for an EOR contract. **Token scopes**: `contracts:read`; EOR

FAQ

Deel integration, answered

How do AI agents use Deel through Open Connector?: Your user connects Deel once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes Deel tools to your agent over MCP or a typed API, with credentials injected server-side on each call.
Is this a Deel MCP server?: Yes. Open Connector can serve Deel as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call Deel actions with credentials injected server-side.
Where do Deel credentials live?: In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

Give your agents Deel — keep the keys.

Open source, self-hostable, with Deel credentials that never leave your infrastructure. Run it from source today.

View source on GitHub How the MCP gateway works →