Skip to main content
Deel logo
  • Category: hr talent & recruitment
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 436
  • Triggers: 0
  • Slug: DEEL
  • Version: 20261101_00

Tools

Slug: DEEL_ACCEPT_CONTRACT_AMENDMENTAccept amendment. Calls Deel’s documented POST /eor/contracts/{contract_id}/amendments/{amendment_id}/accept Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of EOR worker contract.
string
required
A unique identifier for the employee contract amendment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ACCEPT_PROJECT_ASSIGNMENTAccept EOR project assignment as client. Calls Deel’s documented POST /eor/contracts/{contract_id}/project-assignment/accept Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ADD_CANDIDATEAdd a candidate from an external ATS after an offer status change.

Input Parameters

object
required
Candidate details to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ADD_CHILD_ORGANIZATION_ADMINSAdd admins to child organizations. Each submitted admin is added to every submitted child organization, with an outcome reported for each admin and organization pair.

Input Parameters

object
The request payload.
string
required
Opts in to the beta version of this endpoint. Must be true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ADD_GP_CONTRACT_BANK_ACCOUNTAdd bank account. Calls Deel’s documented POST /gp/contracts/{contract_id}/banks Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier for a contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ADD_NOTE_APPLICATIONAdd a rich-text note to an ATS application.

Input Parameters

object
required
Application note details.
string
required
Application to which the note will be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ADD_NOTE_CANDIDATEAdd a rich-text note to an ATS candidate. The note is visible across all of the candidate’s applications.

Input Parameters

object
required
Documented data request body.
string
required
Id of the candidate which the note will be added

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ADD_WORKER_RELATION_CHILDCreate child worker relation. Calls Deel’s documented PUT /hris/worker_relations/profile/{hris_profile_oid}/child Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
HrisProfile ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ADD_WORKER_RELATION_CHILD_EXTERNAL_IDCreate child worker relation with external Id. Calls Deel’s documented PUT /hris/worker_relations/profile/external/{profileId}/child Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
HrisProfile external ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ADD_WORKER_RELATION_PARENTCreate a parent worker relation. Calls Deel’s documented PUT /hris/worker_relations/profile/{hrisProfileOid}/parent Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
HrisProfile ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ADD_WORKER_RELATION_PARENT_EXTERNAL_IDCreate a parent worker relation with external id. Calls Deel’s documented PUT /hris/worker_relations/profile/external/{profile_id}/parent Organization OAuth candidate operation.

Input Parameters

object
required
The request payload containing parent relationship details.
string
required
HrisProfile external ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_APPLY_POSITION_CHANGESApply position changes for a profile, including adding, editing, and deleting positions. Calls Deel’s POST /hris/positions/apply_changes using Organization OAuth.

Input Parameters

object
The request payload containing the position changes to apply.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_APPROVE_EQUITY_EXERCISEApprove an equity exercise. Calls Deel’s documented PATCH /equity/exercise/{public_id} Organization OAuth candidate operation.

Input Parameters

string
required
Equity exercise public ID.
string
required
Documented employer_approval request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_APPROVE_IT_ORDERApprove an IT order awaiting approval, creating assignments for approved items and starting fulfilment. Calls Deel’s POST /it/orders/{order_id}/approve using Organization OAuth.

Input Parameters

string
required
Unique identifier of the IT order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_APPROVE_VISA_APPLICATION_QUOTEApprove a visa application quote. Calls Deel’s documented POST /immigration/visa-application-quotes/{visa_application_quote_id}/approve Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the visa application quote to approve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ARCHIVE_ASSETArchive an IT asset. Calls Deel’s documented POST /it/assets/{asset_id}/archive Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier of the IT asset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ASSIGN_COST_CENTERS_EMPLOYMENT_CONTRACTAssign cost centers to an employment contract. Calls Deel’s documented POST /contracts/{contract_id}/cost-centers Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Employment’s contract ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ASSIGN_WORKERS_IT_HARDWARE_POLICYAssign workers to an IT hardware policy. Calls Deel’s documented POST /it/policies/{it_policy_id}/assign Organization OAuth candidate operation.

Input Parameters

object
required
Workers to assign to the IT policy.
string
required
Unique identifier of the IT policy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ASSIGN_WORKERS_IT_SEATSAssign workers to IT seats, with optional automatic purchase of missing seats when the subscription has insufficient free seats.

Input Parameters

object
required
Workers to give an IT seat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ASSOCIATE_APPLICATION_WITH_INTERVIEW_PLAN_STAGEAssociate an ATS application with an interview plan stage and optionally trigger its activities.

Input Parameters

object
required
Interview plan stage association details.
string
required
Application to associate with the interview plan stage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ATTACH_ON_DEMAND_PAYROLL_ENTRIESAttach entries to On-Demand Payroll. Calls Deel’s documented PATCH /on-demand-payroll/{odp_id}/entries/attach Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Public ID of the On-Demand Payroll.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_BULK_TAG_UPSERTIONSSet tags in bulk. Calls Deel’s documented POST /ats/upsertions/bulk-tags Organization OAuth candidate operation.

Input Parameters

string
required
At least one tag group must be provided. Include tag_id to update an existing tag label, or omit it to create or match case-insensitively.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CANCEL_CLEARANCE_REQUESTCancel a clearance request. Calls Deel’s documented POST /it/clearance-requests/{clearance_request_id}/cancel Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the clearance request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CANCEL_CONTRACTCancel EOR Contract. Calls Deel’s documented POST /eor/contract/{oid}/cancel Organization OAuth candidate operation.

Input Parameters

string
required
Contract oid
object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CANCEL_IT_ORDERCancel an IT order. Calls Deel’s documented POST /it/orders/{order_id}/cancel Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier of the IT order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CANCEL_ON_DEMAND_PAYROLLCancel On-Demand Payroll. Calls Deel’s documented POST /on-demand-payroll/{odp_id}/cancel Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.
string
required
Public ID of the On-Demand Payroll.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CHECKIN_PROJECT_ASSIGNMENTSubmit Project Assignment Checkin Questionnaire Data. Calls Deel’s documented POST /eor/contracts/{contract_id}/project-assignment/checkin Organization OAuth candidate operation.

Input Parameters

object
required
Form submission payload containing respondent type, question answers, and optional version.
string
required
The unique identifier of the contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CLEAR_IT_ASSETCreate a clearance request for an asset. Calls Deel’s documented POST /it/assets/{asset_id}/clear Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier of the IT asset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CLONE_GROUPClone a Group. Calls Deel’s documented POST /groups/{id}/clone Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the group to be cloned.
object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_COLLECT_IT_ASSETCreate a collection for an IT asset. Calls Deel’s documented POST /it/assets/{asset_id}/collect Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier of the IT asset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_COMPLETE_FILE_UPLOADComplete a multipart Deel file upload. The upload claim token must come from Deel’s POST /files response for the same fileid and is scoped to that initialized file. Calls Deel’s documented POST /files/{fileid}/complete Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
File UUID from the register response.
string
required
Single-use, resource-scoped claim token returned by Deel’s POST /files response for the matching file_id. Pass it only to the matching upload status, completion, or file-claim action; do not pass any other token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CONFIRM_CONTRACT_AMENDMENTConfirm amendment. Calls Deel’s documented POST /eor/contracts/{contract_id}/amendments/{amendment_id}/confirm Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of EOR worker contract.
string
required
A unique identifier for the employee contract amendment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_ASSETCreate an IT asset. Calls Deel’s documented POST /it/assets Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_ATS_APPLICATIONCreate an ATS application for an existing candidate and job.

Input Parameters

object
required
Application details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_ATS_ATTACHMENT_FILEUpload an ATS attachment file. Calls Deel’s documented POST /ats/attachments/{attachable_type_slug}/{attachable_id}/{attachment_type_slug} Organization OAuth candidate operation.

Input Parameters

object
required
The file to attach, in binary format
string
required
Unique identifier of the entity the file is attached to
string ("CANDIDATE" | "OFFER" | "JOB_ACTIVITY")
required
Type of the entity the file is attached to
string ("CV" | "LOGO" | "OFFER_LETTER" | "OTHER")
required
Type of the attachment being created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_ATS_CANDIDATECreate a candidate in Deel ATS.

Input Parameters

object
required
Candidate details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_ATS_CANDIDATE_ATTACHMENTUpload ATS Candidate CV. Calls Deel’s documented POST /ats/candidates/{candidate_id}/attachments Organization OAuth candidate operation.

Input Parameters

object
required
CV of the candidate in binary format
string
required
Unique identifier of the candidate to attach the file to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_ATS_JOBCreate ATS Job. Calls Deel’s documented POST /ats/jobs Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_CANDIDATE_TAGSReplace all tags on an ATS candidate. Existing tags omitted from tag_ids are removed.

Input Parameters

array
required
Tag identifiers to associate with the candidate.
string
required
Candidate to tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_CLIENT_CASECreate an immigration case. Calls Deel’s documented POST /immigration/client/cases Organization OAuth candidate operation.

Input Parameters

string
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_CONTRACT_ADJUSTMENTCreate a new adjustment. Calls Deel’s documented POST /adjustments Organization OAuth candidate operation.

Input Parameters

object
required
Details of adjustment to create

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_CONTRACT_DOCUMENTAttach a file to contract. Calls Deel’s documented POST /contracts/{contract_id}/documents Organization OAuth candidate operation.

Input Parameters

object
Documented file request body.
string
required
Deel contract id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_CONTRACT_INVITATIONSend contract to worker. Calls Deel’s documented POST /contracts/{contract_id}/invitations Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.
string
required
Deel contract id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_CONTRACT_MILESTONECreate a Milestone. Calls Deel’s documented POST /contracts/{contract_id}/milestones Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique identifier of the Deel contract where the milestone will be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_CONTRACT_OFF_CYCLE_PAYMENTAdd off-cycle payment. Calls Deel’s documented POST /contracts/{contract_id}/off-cycle-payments Organization OAuth candidate operation.

Input Parameters

object
The off-cycle payment data to submit.
string
required
The unique identifier (ID) of the Deel contract for which the off-cycle payment is being created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_CONTRACTOR_CONTRACT_AMENDMENTUpdate contract. Calls Deel’s documented POST /contracts/{contract_id}/amendments Organization OAuth candidate operation.

Input Parameters

string
required
Documented data request body.
string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_CONTRACT_SIGNATURESign a contract. Calls Deel’s documented POST /contracts/{contract_id}/signatures Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.
string
required
Deel contract id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_CONTRACT_TASKCreate a new task. Calls Deel’s documented POST /contracts/{contract_id}/tasks Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique Deel contract ID associated with the task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_CONTRACT_TASK_REVIEWReview a single task. Calls Deel’s documented POST /contracts/{contract_id}/tasks/{task_id}/reviews Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique ID of the task to be reviewed.
string
required
The unique Deel contract ID associated with the task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_CONTRACT_TERMINATIONTerminate contract. Calls Deel’s documented POST /contracts/{contract_id}/terminations Organization OAuth candidate operation.

Input Parameters

object
required
Termination data. At minimum, you must provide either terminate_now: true (for immediate termination) OR completion_date (for scheduled termination).
string
required
The unique identifier of the contractor contract

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_DEAL_REGISTRATIONCreate a deal registration. Calls Deel’s documented POST /organizations/deal-registrations Organization OAuth candidate operation.

Input Parameters

object
The request payload.
string
required
Opts in to the beta version of this endpoint. Must be true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_DIRECT_EMPLOYEECreate a direct employee. Calls Deel’s documented POST /people Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_EMPLOYEE_RESIGNATIONRequest contract resignation. Calls Deel’s documented POST /eor/contracts/{contract_id}/offboarding/resignation Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_EOR_CONTRACTSubmit an Employer of Record contract for a quote on behalf of the authenticated user. The Organization OAuth connection must have contracts:write and access to the referenced organization resources.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_EOR_CONTRACT_AMENDMENTCreate amendment. Calls Deel’s documented POST /eor/contracts/{contract_id}/amendments Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique identifier of the EOR worker contract

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_EOR_OFFBOARDING_CLIENT_SIGN_OFFCreate client sign off. Calls Deel’s documented POST /eor/contracts/{contract_id}/offboarding/review-client-sign-offs Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_EOR_WORKERCreate an EOR worker account for an existing contract.

Input Parameters

object
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_EQUITY_OR_TOKEN_TAX_EVENTCreate equity or token tax event. Calls Deel’s documented POST /equities-tokens/tax-events Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_GP_CONTRACTCreate a Global Payroll contract on behalf of the authenticated user. The Organization OAuth connection must have contracts:write and access to the referenced team and legal entity.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_GP_WORKERCreate a Global Payroll worker and their contract in a single call.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_GP_WORKER_ADDITIONAL_INFORMATIONAdd GP Workers Additional Information. Calls Deel’s documented POST /gp/workers/contracts/{contract_id}/additional-information Organization OAuth candidate operation.

Input Parameters

object
required
Additional-information values keyed by public API field key.
string
required
The unique public identifier of the contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_GP_WORKER_BANKAdd bank account. Calls Deel’s documented POST /gp/workers/{worker_id}/banks Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier for a worker in UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_GP_WORKER_TERMINATIONRequest termination. Calls Deel’s documented POST /gp/workers/{worker_id}/terminations Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier for a worker in UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_GROUPCreate a group. Calls Deel’s documented POST /groups Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_IC_CONTRACTCreate an independent-contractor contract on behalf of the authenticated user. The Organization OAuth connection must have contracts:write and permission to the referenced team and legal entity.

Input Parameters

string
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_IC_INVOICING_TAXCreate IC invoicing tax. Calls Deel’s documented POST /contracts/{contract_id}/ic-invoicing-taxes Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Deel Contract ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_INVOICE_ADJUSTMENTCreate an invoice adjustment. Calls Deel’s documented POST /invoice-adjustments Organization OAuth candidate operation.

Input Parameters

object
required
Payload attributes required to create one invoice adjustment with optional approval, preset, and grouping metadata.
string
Add this invoice adjustment as recurring

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_INVOICE_ADJUSTMENT_REVIEWReview a single invoice adjustment. Calls Deel’s documented POST /invoice-adjustments/{id}/reviews Organization OAuth candidate operation.

Input Parameters

string
required
ID of an existing invoice adjustment.
object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_IT_ORDERCreate an IT order. Calls Deel’s documented POST /it/orders Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_MANAGERCreate a Manager. Calls Deel’s documented POST /managers Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_OFFBOARDING_TERMINATIONInitiate EOR contract termination request. Calls Deel’s documented POST /eor/contracts/{contract_id}/offboarding/termination Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_ON_DEMAND_PAYROLLCreate On-Demand Payroll. Calls Deel’s documented POST /on-demand-payroll/contract/{contract_id} Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Public ID (oid) of the contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_ORGANIZATION_ROLECreate organization custom role.. Calls Deel’s documented POST /roles Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_ORGANIZATION_SECURE_VAULT_FOLDERCreate Organization Secure Vault Folder. Calls Deel’s documented POST /organizations/secure-vault/folders Organization OAuth candidate operation.

Input Parameters

object
required
The folder to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_ORGANIZATION_STRUCTURECreate a new HRIS Organization Structure.. Calls Deel’s documented POST /hris/organization_structures Organization OAuth candidate operation.

Input Parameters

object
required
Organization structure and initial teams.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_PAYMENT_STATEMENTCreate a Deel payment statement for up to 100 invoices and initiate payment. This is an irreversible financial operation; use a unique idempotency key.

Input Parameters

object
required
Invoices and settlement options.
string
required
Unique idempotency key. Reuse only for an identical request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_PERSON_WITHOUT_CONTRACTCreate a person without a contract. Calls Deel’s documented POST /pwac Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_REGULAR_TERMINATIONTermination Request. Calls Deel’s documented POST /eor/{oid}/terminations/regular Organization OAuth candidate operation.

Input Parameters

string
required
Public contract id
object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_REQUEST_EXERCISE_EQUITYCreate a request to exercise equity.. Calls Deel’s documented POST /equity/exercise Organization OAuth candidate operation.

Input Parameters

string
required
Documented fmv request body.
number
required
Documented quantity request body.
string
required
Documented issuer_id request body.
string
required
Documented worker_id request body.
string
required
Documented address_zip request body.
string
required
Documented exercise_id request body.
string
required
Documented address_city request body.
string
required
Documented address_state request body.
string
required
Documented address_street request body.
string
required
Documented stakeholder_id request body.
string
required
Documented address_country request body.
string
required
Documented option_grant_id request body.
string
required
Documented fmv_currency_code request body.
string
required
Documented stakeholder_email request body.
string
required
Documented option_grant_issue request body.
string
required
Documented option_grant_label request body.
string
required
Documented option_grant_currency request body.
string
required
Documented option_grant_issue_date request body.
string
required
Documented option_grant_expiry_date request body.
string
required
Documented stakeholder_relationship request body.
string
required
Documented option_grant_strike_price request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_RESIGNATIONRequest EOR Contract Resignation. Calls Deel’s documented POST /eor/{oid}/terminations/resignation Organization OAuth candidate operation.

Input Parameters

string
required
Public contract oid
object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_ROOT_TIMESHEETS_PRESETCreate Hourly Report Root Preset. Calls Deel’s documented POST /timesheets/root-presets Organization OAuth candidate operation.

Input Parameters

string
Documented file request body.
string ("RATE" | "TRACKING")
The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate
string
required
Documented title request body.
string
Documented description request body.
array
Documented hourly_report_presets request body.
string ("ASYNC" | "SYNC")
Determines whether presets should be processed synchronously or asynchronously

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_TIME_OFF_REQUESTCreate time-off request. Calls Deel’s documented POST /time_offs Organization OAuth candidate operation.

Input Parameters

object
required
The time off request data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_TIMESHEETCreate a timesheet entry. Calls Deel’s documented POST /timesheets Organization OAuth candidate operation.

Input Parameters

object
required
Payload attributes required to create one timesheet entry with optional approval, preset, and grouping metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_TIMESHEET_REVIEWReview a single timesheet. Calls Deel’s documented POST /timesheets/{timesheet_id}/reviews Organization OAuth candidate operation.

Input Parameters

object
required
Review decision payload to apply to the timesheet entry.
string
required
ID of an existing timesheet

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_TIMESHEETS_PRESETCreate Hourly Report Preset. Calls Deel’s documented POST /timesheets/presets Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_TIME_TRACKING_SHIFT_RATECreate a New Shift Rate. Calls Deel’s documented POST /v2/time_tracking/shift_rates Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_TIME_TRACKING_SHIFTSCreate shifts. Calls Deel’s documented POST /v2/time_tracking/shifts Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_TIME_TRACKING_SHIFTS_RAWCreate raw time tracking shifts. Calls Deel’s documented POST /v2/time_tracking/shifts/raw Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_VENDOR_BILLCreate a vendor bill from external invoice-provider data.

Input Parameters

object
required
Vendor bill data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_VERIFF_SESSIONCreate Veriff session. Calls Deel’s documented POST /veriff/session Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_WEBHOOKCreate a webhook. Calls Deel’s documented POST /webhooks Organization OAuth candidate operation.

Input Parameters

string
required
Documented url request body.
string
required
Documented name request body.
array
required
Documented events request body.
string ("enabled" | "disabled")
required
Status of webhook.
string
required
Documented api_version request body.
string
required
Documented description request body.
string
Documented signing_key request body.
boolean
Documented include_child_orgs request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_WORKER_RELATION_PROFILECreate a worker relation. Calls Deel’s documented POST /hris/worker_relations/profile Organization OAuth candidate operation.

Input Parameters

object
The request payload containing the relationship details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_WORKER_RELATION_PROFILE_EXTERNAL_IDCreate worker relation with external Ids. Calls Deel’s documented POST /hris/worker_relations/profile/external Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_WORKER_RELATION_TYPECreate worker relation type. Calls Deel’s documented POST /hris/worker_relations/types Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_CREATE_WORK_STATEMENT_PAYMENT_POLICYCreate a work statement payment policy. Calls Deel’s documented POST /work-statement-payment-policies Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DECIDE_CLEARANCE_REQUESTApprove or reject quotes on a clearance request. Calls Deel’s documented POST /it/clearance-requests/{clearance_request_id}/decide Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier of the clearance request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DECLINE_IT_ORDERReject an IT order. Calls Deel’s documented POST /it/orders/{order_id}/decline Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the IT order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELAY_ONBOARDINGDelay EOR employee onboarding. Calls Deel’s documented PATCH /eor/contract/{oid}/delay-onboarding Organization OAuth candidate operation.

Input Parameters

string
required
Contract oid
object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_CONTRACT_ADJUSTMENTDelete an adjustment. Calls Deel’s documented DELETE /adjustments/{id} Organization OAuth candidate operation.

Input Parameters

string
required
Deel adjustment id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_CONTRACT_AMENDMENTCancel amendment. Calls Deel’s documented DELETE /eor/contracts/{contract_id}/amendments/{amendment_id} Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of EOR worker contract.
string
required
A unique identifier for the employee contract amendment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_CONTRACT_CUSTOM_FIELDDelete Contract custom field by Id. Calls Deel’s documented DELETE /contracts/{contract_id}/custom_fields/{id} Organization OAuth candidate operation.

Input Parameters

string
required
Custom field id.
string
required
Contract id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_CONTRACT_INVITATIONSRemove invite. Calls Deel’s documented DELETE /contracts/{contract_id}/invitations Organization OAuth candidate operation.

Input Parameters

string
required
Deel contract id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_CONTRACT_MILESTONEDelete a Milestone. Calls Deel’s documented DELETE /contracts/{contract_id}/milestones/{milestone_id} Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the Deel contract from which the milestone will be deleted.
string
required
The unique identifier of the milestone that is to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_CONTRACT_TASKDelete task. Calls Deel’s documented DELETE /contracts/{contract_id}/tasks/{task_id} Organization OAuth candidate operation.

Input Parameters

string
The reason for deleting the task. This can be used for auditing purposes.
string
required
The unique identifier of the task to be deleted.
string
required
The unique identifier of the Deel contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_CONTRACT_TERMINATIONDelete Contract Termination Request. Calls Deel’s documented DELETE /contracts/{contract_id}/terminations Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier for the contract

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_GROUPDelete a group. Calls Deel’s documented DELETE /groups/{id} Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the group to be archived.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_IC_INVOICING_TAXDelete IC invoicing tax. Calls Deel’s documented DELETE /contracts/{contract_id}/ic-invoicing-taxes/{tax_type} Organization OAuth candidate operation.

Input Parameters

string ("WITHHOLDING_TAX" | "VAT")
required
IC tax type
string
required
Deel Contract ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_INVOICE_ADJUSTMENTDelete adjustment. Calls Deel’s documented DELETE /invoice-adjustments/{id} Organization OAuth candidate operation.

Input Parameters

string
required
Invoice adjustment id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_MULTIPLE_SHIFTS_EXTERNAL_IDDelete multiple shifts by External ID. Calls Deel’s documented POST /v2/time_tracking/shifts/bulk-delete Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_ORGANIZATION_SECURE_VAULT_FILEDelete Organization Secure Vault File. Calls Deel’s documented DELETE /organizations/secure-vault/files/{file_id} Organization OAuth candidate operation.

Input Parameters

string
required
Public UUID of the Organization Secure Vault file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_ORGANIZATION_SECURE_VAULT_FOLDERDelete Organization Secure Vault Folder. Calls Deel’s documented DELETE /organizations/secure-vault/folders/{folder_id} Organization OAuth candidate operation.

Input Parameters

string
required
Public UUID of the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_ORGANIZATION_STRUCTUREDelete an Org Structure from the Organization. Calls Deel’s documented DELETE /hris/organization_structures/{hris_org_structure_id} Organization OAuth candidate operation.

Input Parameters

string
required
Org Structure

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_ORGANIZATION_STRUCTURE_EXTERNAL_IDDelete an Org Structure from the Organization by external ID. Calls Deel’s documented DELETE /hris/organization_structures/external/{external_id} Organization OAuth candidate operation.

Input Parameters

string
required
External ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_PERSON_CUSTOM_FIELDDelete the custom field value from Worker by Id. Calls Deel’s documented DELETE /people/{worker_id}/custom_fields/{id} Organization OAuth candidate operation.

Input Parameters

string
required
Custom field id.
string
required
Worker id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_SHIFT_RATE_BY_EXTERNAL_IDPermanently delete a shift rate by the custom external ID assigned when it was created; deletion fails while the rate is associated with an active shift.

Input Parameters

string
required
Custom shift-rate identifier assigned when the shift rate was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_TIME_OFF_REQUESTCancel time-off request. Calls Deel’s documented DELETE /time_offs/{time_off_id} Organization OAuth candidate operation.

Input Parameters

string
required
Time off request id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_TIMESHEET_IDDelete a timesheet entry. Calls Deel’s documented DELETE /timesheets/{timesheet_id} Organization OAuth candidate operation.

Input Parameters

string
Reason for deleting an existing task
string
required
ID of an existing timesheet

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_TIMESHEETS_PRESETDelete Hourly Report Preset. Calls Deel’s documented DELETE /timesheets/presets/{id} Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the hourly report preset to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_TIME_TRACKING_SHIFT_EXTERNAL_IDDelete a Shift by External ID. Calls Deel’s documented DELETE /time_tracking/shifts/{external_id} Organization OAuth candidate operation.

Input Parameters

string
required
The unique external identifier of the shift to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_WEBHOOKDelete a webhook. Calls Deel’s documented DELETE /webhooks/{id} Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the webhook subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_WORKER_RELATION_PROFILEDelete a worker relation. Calls Deel’s documented DELETE /hris/worker_relations/profile/{hrisProfileOid} Organization OAuth candidate operation.

Input Parameters

string
required
Public worker relation ID to delete, despite the provider path parameter name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_WORKER_RELATION_PROFILE_EXTERNAL_IDDelete a worker relation by external id. Calls Deel’s documented DELETE /hris/worker_relations/profile/external/{profileId} Organization OAuth candidate operation.

Input Parameters

string
required
External worker relation ID to delete, despite the provider path parameter name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_WORKER_RELATION_TYPEDelete a worker relation type. Calls Deel’s documented DELETE /hris/worker_relations/types/{type_id} Organization OAuth candidate operation.

Input Parameters

string
required
Worker Relation Type ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELETE_WORKER_RELATION_TYPE_EXTERNAL_IDDelete a worker relation type by external id. Calls Deel’s documented DELETE /hris/worker_relations/types/external/{externalId} Organization OAuth candidate operation.

Input Parameters

string
required
Worker Relation Type external ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DELIVER_IT_ASSETCreate a delivery request for an IT asset. Calls Deel’s documented POST /it/assets/{asset_id}/deliver Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier of the IT asset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DETACH_ON_DEMAND_PAYROLL_ENTRIESDetach entries from an On-Demand Payroll, moving selected entries to regular payroll or permanently deleting selected entries.

Input Parameters

object
required
Documented data request body.
string
required
Public ID of the On-Demand Payroll.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DOWNLOAD_GP_WORKER_PAYSLIPRetrieve a pre-signed download URL for a Global Payroll worker’s payslip PDF.

Input Parameters

string
required
Unique identifier for the worker.
string
required
Public identifier for the payslip.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_DOWNLOAD_HRX_DOCUMENTSRetrieve a pre-signed download URL for an EOR contract’s HRX document PDF.

Input Parameters

string
required
The unique identifier of the employee contract.
string
required
The unique identifier of the document to download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_ENROL_ASSET_INTO_ADDONAssign an addon to an IT asset. Calls Deel’s documented POST /it/assets/{asset_id}/addons/{addon_id}/assign Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the addon
string
required
Unique identifier of the IT asset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_ADDITIONAL_COSTSGet EOR Additional Costs. Calls Deel’s documented GET /eor/additional-costs/{country} Organization OAuth candidate operation.

Input Parameters

string
required
The two-letter ISO code of the country for which to retrieve the EOR additional costs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_AMENDMENT_DATA_POINTS_CONFIGURATION_COUNTRYGet amendment data points configuration by country. Calls Deel’s documented GET /eor/contracts/amendments/data-points/configuration Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of results to return per page.
string
Cursor from a previous response to fetch the next page of results.
boolean
When true, returns only enabled data points. A data point is enabled if at least one of its items is not DISABLED_AMENDMENTS.
array
Optional list of ISO 3166-1 alpha-2 country codes to filter results. Returns all countries if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_AML_DETAILSGet entity screening details. Calls Deel’s documented GET /screenings/aml/{entity_type}/{entity_id} Organization OAuth candidate operation.

Input Parameters

string
required
UUID v4 of the entity
string ("profile" | "hris_profile" | "legal_entity")
required
The type of entity to screen. Only ‘profile’, ‘hris_profile’, ‘legal_entity’ are accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_ATS_APPLICATIONRetrieve complete details for one ATS application.

Input Parameters

string
required
Application to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_ATS_APPLICATION_FORMRetrieve ATS Application form. Calls Deel’s documented GET /ats/application-forms/{application_form_id} Organization OAuth candidate operation.

Input Parameters

string
required
Id of the application form

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_ATS_CANDIDATERetrieve an ATS candidate. Calls Deel’s documented GET /ats/candidates/{candidate_id} Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the candidate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_ATS_JOB_POSTINGRetrieve ATS job posting. Calls Deel’s documented GET /ats/job-postings/{job_posting_id} Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the job posting to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_BUSINESS_VISA_REQUIREMENTGet business visa eligibility and requirements. Calls Deel’s documented GET /immigration/visa-requirement/business Organization OAuth candidate operation.

Input Parameters

string
required
The nationality country code of the person in ISO 3166-1 alpha-2 format
string ("INTERNAL_BUSINESS_WITH_WORK_FOR_CLIENT" | "INTERNAL_BUSINESS_WITHOUT_WORK_FOR_CLIENT" | "MEETINGS_WITH_OR_FOR_A_CLIENT" | "MEETINGS_WITH_POTENTIAL_CLIENTS" | "NEGOTIATING_CONTRACTS_OR_SIGNING_AGREEMENTS" | "OTHER_EXTERNAL_BUSINESS" | "CONFERENCE" | "TEAM_OFFSITE" | "SPEAKING_AT_CONFERENCE_UNPAID" | "SPEAKING_AT_CONFERENCE_PAID" | "ATTENDING_INTERNAL_TRAINING" | "ATTENDING_EXTERNAL_TRAINING" | "DELIVERING_TRAINING_TO_INTERNAL_PARTICIPANTS" | "DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_UNPAID" | "DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_PAID" | "PARTICIPATION_IN_RESEARCH_PROJECTS_AND_STUDIES" | "ASSEMBLY_MAINTENANCE_REPAIR_INSTALLATION" | "TECHNICAL_SUPPORT_OR_SUPERVISION" | "OTHER_HANDS_ON_LABOUR" | "MARKET_RESEARCH_AND_EXPLORING_INVESTMENT_OPPORTUNITIES" | "OTHER")
required
The reason for the trip
string
required
The trip end date in ISO 8601 format (YYYY-MM-DD)
string
required
The trip start date in ISO 8601 format (YYYY-MM-DD)
string
required
The residence country code of the person in ISO 3166-1 alpha-2 format
string
The second nationality country code of the person in ISO 3166-1 alpha-2 format (optional)
string
required
The destination country code of the trip in ISO 3166-1 alpha-2 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CASE_TIMELINEGet case timeline. Calls Deel’s documented GET /immigration/cases/{case_id}/timeline Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the case whose timeline should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CLEARANCE_REQUESTRetrieve a clearance request. Calls Deel’s documented GET /it/clearance-requests/{clearance_request_id} Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the clearance request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CLIENT_CASEGet immigration case details. Calls Deel’s documented GET /immigration/client/cases/{id} Organization OAuth candidate operation.

Input Parameters

string
required
Immigration case id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CONTRACTRetrieve a single contract. Calls Deel’s documented GET /contracts/{contract_id} Organization OAuth candidate operation.

Input Parameters

array
Include additional fields in the response. Multiple values can be passed as comma-separated list.
string
required
Unique identifier of the contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CONTRACT_ADDITIONAL_INFOGet country-specific additional information for a Global Payroll contract via Deel’s GET /contracts/{contract_id}/additional-info operation.

Input Parameters

string
required
The unique identifier of the GP contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CONTRACT_ADJUSTMENTRetrieve an adjustment. Calls Deel’s documented GET /adjustments/{id} Organization OAuth candidate operation.

Input Parameters

string
required
Deel adjustment id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CONTRACT_AMENDMENT_IDGet amendment by ID. Calls Deel’s documented GET /eor/contracts/{contract_id}/amendments/{amendment_id} Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of EOR worker contract.
string
required
A unique identifier for the employee contract amendment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CONTRACT_AMENDMENT_PDFRetrieve a pre-signed download URL for an EOR contract amendment PDF. The URL is valid for 15 minutes.

Input Parameters

string
required
The unique identifier of EOR worker contract.
string
required
A unique identifier for the employee contract amendment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CONTRACT_AMENDMENTS_VALIDATION_SETTINGSGet amendment validation settings. Calls Deel’s documented GET /eor/contracts/{contract_id}/amendments/validation/settings Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of EOR worker contract.
string
The employment state of the EOR worker contract

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CONTRACT_CUSTOM_FIELD_DEFINITIONRetrieve one contract custom-field definition by its ID, including its type, settings, placement, and access configuration.

Input Parameters

string
required
Custom field id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CONTRACT_MILESTONE_IDRetrieve a single milestone. Calls Deel’s documented GET /contracts/{contract_id}/milestones/{milestone_id} Organization OAuth candidate operation.

Input Parameters

string
required
Deel contract id.
string
required
ID of milestone to return

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CONTRACT_OFFBOARDING_ATTACHMENT_IDRetrieve an EOR contract’s offboarding attachment as a downloadable file, with a maximum download size of 25,000,000 bytes.

Input Parameters

string
required
The unique identifier of the employee contract.
string
required
The unique identifier of the attachment to download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CONTRACT_OFF_CYCLE_PAYMENTRetrieve a single off-cycle payment. Calls Deel’s documented GET /contracts/{contract_id}/off-cycle-payments/{off_cycle_payment_id} Organization OAuth candidate operation.

Input Parameters

string
required
Deel contract id.
string
required
Deel off-cycle payment id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CONTRACT_PREVIEWPreview a contract agreement. Calls Deel’s documented GET /contracts/{contract_id}/preview Organization OAuth candidate operation.

Input Parameters

string
required
Deel contract id.
string
ID of an existing contract template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_COUNTRY_FIELDS_LEGAL_ENTITYGet registration/tax identifier fields for a country. Calls Deel’s documented GET /legal-entities/country-fields/{country_code} Organization OAuth candidate operation.

Input Parameters

string
required
ISO 3166-1 alpha-2 country code. Case-insensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_COUNTRY_GUIDEGet a country’s Knowledge Hub guide, organized by audience and contract type with category fields and related knowledge or compliance articles.

Input Parameters

string
required
Country code for which we need to fetch the country guides

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CREATE_CONTRACT_FORMFetch EOR Contract form. Calls Deel’s documented GET /forms/eor/create-contract/{country_code} Organization OAuth candidate operation.

Input Parameters

string
The selected state code of the contract. This is only required for countries that specify it.
string
The selected start date of the contract in ISO 8601 formatted date string.
string
required
Two-letter country code in ISO 3166-1 alpha-2 format
integer
The selected number of work hours per week.
integer
The contract duration in days for definite contracts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_CURRENT_PERSONAL_PROFILEReturn the profile of the currently authenticated user, not an organization-wide person lookup. This Organization OAuth toolkit requires authenticated-user context plus people:read for this route.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_EMPLOYEE_ADDITIONAL_INFO_TEMPLATEList the country- and contract-type-specific additional information fields needed to build or validate an employee onboarding form.

Input Parameters

string ("eor" | "gp")
required
The contract type. Must be ‘eor’ (Employer of Record) or ‘gp’ (Global Payroll).
string
required
ISO 3166-1 alpha-2 country code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_EMPLOYEE_AGREEMENT_DRAFT_PREVIEWGet employee agreement draft preview. Calls Deel’s documented GET /eor/contracts/{contract_id}/employee-agreement-draft-preview Organization OAuth candidate operation.

Input Parameters

string
Task ID from a previous response. Omit on first call. Provide on subsequent calls to poll for completion.
string
required
The unique identifier of the EOR contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_EOR_CONTRACT_DOCUMENT_TYPEFetch the framework agreement document for an EOR contract as a downloadable file reference.

Input Parameters

string
required
The type of document. Currently only FRAMEWORK_AGREEMENT is supported.
string
required
EOR contract ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_EOR_CONTRACT_OFFBOARDING_REQUIRED_INFORMATIONGet additional information required to request employee termination. Calls Deel’s documented GET /eor/contracts/{contract_id}/offboarding/required-information Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_EOR_CONTRACT_START_DATECalculate the earliest possible EOR employment start date and payroll timing for a team, employment country, and optional nationality, visa, legal-entity, state, or special-job inputs.

Input Parameters

string
required
Team ID
boolean
Whether a work visa is required
string
Special job ID (if applicable)
Legal entity ID
string
State or province of employment
string
required
Employment country in ISO 3166-1 alpha-2 format
string
Employee nationality in ISO 3166-1 alpha-2 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_EOR_HIRING_GUIDE_COUNTRYRetrieve detailed hiring guide for a country. Calls Deel’s documented GET /eor/validations/{country_code} Organization OAuth candidate operation.

Input Parameters

string
required
The two-letter ISO code of the country for which to retrieve the hiring guide.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_FILE_UPLOAD_STATUSCheck a Deel file upload’s virus-scan status. The upload claim token must come from Deel’s POST /files response for the same fileid and is scoped to that initialized file. Calls Deel’s documented GET /files/{fileid}/status Organization OAuth candidate operation.

Input Parameters

string
required
File UUID from the register response.
string
required
Single-use, resource-scoped claim token returned by Deel’s POST /files response for the matching file_id. Pass it only to the matching upload status, completion, or file-claim action; do not pass any other token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_GP_REPORT_GROSS_NET_CSVDownload gross to net report. Calls Deel’s documented GET /gp/reports/{id}/gross_to_net/csv Organization OAuth candidate operation.

Input Parameters

string
required
Id of the gp payroll report.
string
Currency to be used in the report calculation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_HOURLY_REPORT_ROOT_PRESET_IDGet Hourly Report Root Preset by ID. Calls Deel’s documented GET /timesheets/root-presets/{id} Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the hourly report root preset to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_IMMIGRATION_DOCUMENTRetrieve one immigration document by ID, including its review status, document type, expiration date, and download links.

Input Parameters

string
required
Immigration case document id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_INTERVIEW_TRANSCRIPTGet one page of an interview transcript as ordered speaker segments, with a cursor for additional pages.

Input Parameters

integer
Maximum number of transcript segments to return per page.
string
Pagination cursor returned by a previous response.
string
required
Unique identifier of the interview to retrieve the transcript for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_INVOICE_ADJUSTMENT_IDInvoice line item by Id. Calls Deel’s documented GET /invoice-adjustments/{id} Organization OAuth candidate operation.

Input Parameters

string
required
ID of an existing invoice

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_INVOICE_IDRetrieve one Deel invoice and its line items by invoice ID.

Input Parameters

string
required
Invoice ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_IT_AGREEMENTRetrieve an agreement. Calls Deel’s documented GET /it/agreements/{agreement_id} Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the agreement

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_IT_ASSETRetrieve an IT asset. Calls Deel’s documented GET /it/assets/{asset_id} Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the IT asset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_IT_ORDERRetrieve an IT order. Calls Deel’s documented GET /it/orders/{order_id} Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the IT order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_IT_PRODUCTRetrieve a product’s catalog details. Calls Deel’s documented GET /it/products/{product_id} Organization OAuth candidate operation.

Input Parameters

string
ISO 3166 alpha-2 country code. When set, restricts returned variants to those shipping to this country.
string
required
Unique identifier of the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_IT_WAREHOUSERetrieve a warehouse. Calls Deel’s documented GET /it/warehouses/{warehouse_id} Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the warehouse

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_KYC_DETAILSGet worker’s KYC details. Calls Deel’s documented GET /screenings/kyc/details Organization OAuth candidate operation.

Input Parameters

string
Worker’s profile public ID client requests to fetch KYC details for, This parameter is mutually exclusive with worker_profile_id
string
Worker’s contract ID. This parameter is required in case there are multiple profiles associated to the target worker. For example, when worker used to work for the former company he had another profile ID. So we need contract ID to properly resolve profile’s KYC details. In case this parameter is not provided and multiple associated profiles are found, exception with 409 status code will be thrown
string
Worker’s HRIS profile public ID client requests to fetch KYC details for. This parameter is mutually exclusive with profile_id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_KYC_VERIFICATION_METHODGet the supported KYC verification method for an identity document type and its ISO issuing-country code.

Input Parameters

string
required
The document’s issuing country code (ISO 3166-1 alpha-2)
string ("passport" | "government_id" | "driving_license" | "other")
required
The document to be provided during KYC

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_MULTIPLE_EOR_CONTRACT_FORMSFetch multiple EOR Contract forms. Calls Deel’s documented POST /forms/eor/create-contract/definitions Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
integer
Maximum number of countries to return in a single response. Defaults to 10.
string
Pagination cursor for fetching subsequent pages of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_ONBOARDING_BY_HRIS_PROFILEGet onboarding details by employee HRIS profile ID. Calls Deel’s documented GET /onboarding/tracker/hris_profile/{hris_profile_id} Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the employee HRIS profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_ONBOARDING_DETAILS_ONBOARDING_TRACKER_IDGet onboarding details by onboarding tracker ID. Calls Deel’s documented GET /onboarding/tracker/{tracker_id} Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the onboarding tracker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_ORGANIZATION_SECURE_VAULT_FOLDERGet Organization Secure Vault Folder. Calls Deel’s documented GET /organizations/secure-vault/folders/{folder_id} Organization OAuth candidate operation.

Input Parameters

string
required
Public UUID of the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_ORGANIZATION_STRUCTUREGet Organization Structure. Calls Deel’s documented GET /hris/organization_structures/{hris_org_structure_id} Organization OAuth candidate operation.

Input Parameters

string
required
HRIS Organization Structure ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_ORGANIZATION_STRUCTURE_EXTERNAL_IDGet Organization Structure by External ID. Calls Deel’s documented GET /hris/organization_structures/external/{external_id} Organization OAuth candidate operation.

Input Parameters

string
required
External ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_PAYMENT_STATEMENTRetrieve a Deel payment statement by its unique identifier.

Input Parameters

string
required
Unique payment statement identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_PAYROLL_CYCLE_GROSS_TO_NET_REPORTGet a paginated gross-to-net report for a payroll cycle, with contract-level additions, deductions, benefits, contributions, totals, currencies, and payment details.

Input Parameters

integer
Maximum number of items to return. Defaults to 20.
string
Cursor for pagination of results.
string
required
The unique identifier for the payroll event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_PAYROLL_MIGRATION_IMPORTGet a payroll migration import. Calls Deel’s documented GET /gp/legal-entities/{legal_entity_id}/payroll-migration-imports/{import_id} Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the payroll migration import, as returned when it was submitted.
The unique identifier of the legal entity the payroll migration import belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_PERSON_CUSTOM_FIELDGet custom field from people by id. Calls Deel’s documented GET /people/custom_fields/{id} Organization OAuth candidate operation.

Input Parameters

string
required
Custom field id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_PERSON_IDRetrieve a single person. Calls Deel’s documented GET /people/{hris_profile_id} Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier for the person.
boolean
Include custom fields in the response.
boolean
Include worker relations in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_PERSON_PERSONAL_INFOGet personal information by id. Calls Deel’s documented GET /people/{worker_id}/personal Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier for a worker (External ID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_PERSON_PERSONAL_INFO_EXTERNAL_IDGet worker profile by external ID. Calls Deel’s documented GET /people/external/{worker_id}/personal Organization OAuth candidate operation.

Input Parameters

string
required
System-wide external identifier for a worker record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_POSITIONS_PROFILEGet Positions by Profile. Calls Deel’s documented GET /hris/positions/profile/{hris_profile_id} Organization OAuth candidate operation.

Input Parameters

string
required
HRIS Profile ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_PROFILES_ASSIGNED_POLICYGet Profiles Assigned to Policy. Calls Deel’s documented GET /time-offs/policy/{policy_id}/assignments Organization OAuth candidate operation.

Input Parameters

string
Pagination cursor returned by Deel.
integer
Items per page (max 100)
string
required
Policy UID, as returned by the Get Policies for Organization endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_PROJECT_ASSIGNMENTFetch EOR project assignment PDF. Calls Deel’s documented GET /eor/contracts/{contract_id}/project-assignment Organization OAuth candidate operation.

Input Parameters

string
This field is to ensure that the latest version of the project assignment PDF matches the version received from the webhook. If it is not sent, the version validation is not performed and the endpoint returns the PDF. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the PDF is returned.
string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_PROJECT_ASSIGNMENT_CHECKINFetch Project Assignment Checkin Questionnaire Data. Calls Deel’s documented GET /eor/contracts/{contract_id}/project-assignment/checkin Organization OAuth candidate operation.

Input Parameters

string ("EMPLOYEE" | "CLIENT")
required
Whether to fetch the employee or client check-in questionnaire.
string
This field is to ensure that the latest version of the project assignment checkin matches the version received from the webhook. If it is not sent, the version validation is not performed. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the data is returned.
string
required
The unique identifier of the contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_ROLES_CURRENT_ORGANIZATIONGet the roles of the current organization.. Calls Deel’s documented GET /roles Organization OAuth candidate operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_SHIFT_RATE_BY_EXTERNAL_IDRetrieve a Shift Rate by External ID. Calls Deel’s documented GET /time_tracking/shift_rates/{external_id} Organization OAuth candidate operation.

Input Parameters

string
required
The unique external identifier of the shift rate to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_STATIC_EMPLOYEE_BANK_TRANSFER_REQUIREMENTSGet static employee bank transfer requirements. Calls Deel’s documented GET /payouts/employees/methods/bank-transfers/requirements Organization OAuth candidate operation.

Input Parameters

string
required
Bank country as an ISO 3166-1 alpha-2 code.
string
required
Payout currency as an ISO 4217 code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_TERMINATIONGet termination. Calls Deel’s documented GET /eor/{oid}/terminations/{terminationId} Organization OAuth candidate operation.

Input Parameters

string
required
Public contract oid
string
required
Termination id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_TERMINATION_DETAILSRetrieve termination details. Calls Deel’s documented GET /offboarding/tracker/{id} Organization OAuth candidate operation.

Input Parameters

string
required
Base64 offboarding tracker ID from the unique_id field returned by LIST_OFFBOARDING_LIST.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_TERMINATION_DETAILS_HRIS_PROFILE_IDENTIFIERRetrieve termination details by HRIS profile identifier. Calls Deel’s documented GET /offboarding/tracker/hris_profile/{oid} Organization OAuth candidate operation.

Input Parameters

string
required
Unique hris profile oid

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_TIME_OFF_ATTACHMENT_DOWNLOAD_URLGet time-off attachment download URL. Calls Deel’s documented GET /time_offs/attachments/{attachment_id}/download Organization OAuth candidate operation.

Input Parameters

string
required
Time-off attachment id (the id field from the attachments array in time-off responses)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_TIME_OFF_DAILIESGet Work Schedule and Holidays. Calls Deel’s documented GET /time_offs/dailies Organization OAuth candidate operation.

Input Parameters

string
End date of non working days date range
array
List of countries to be fetched
string
Start date of non working days date range
array
HRIS profile ids

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_TIME_OFF_ENTITLEMENTSGet Profile Entitlements. Calls Deel’s documented GET /time_offs/profile/{hris_profile_id}/entitlements Organization OAuth candidate operation.

Input Parameters

string
required
HRIS profile ID
string
Policy type name
string
Tracking period date

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_TIME_OFF_EVENTSGet Time Off Events for Profile. Calls Deel’s documented GET /time_offs/time-off-events Organization OAuth candidate operation.

Input Parameters

string
Policy id
string
required
Worker hris profile id
string
required
Time off type id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_TIMESHEET_IDRetrieve a single timesheet entry. Calls Deel’s documented GET /timesheets/{timesheet_id} Organization OAuth candidate operation.

Input Parameters

string
required
ID of an existing timesheet

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_TIMESHEETS_PRESET_IDGet Hourly Report Preset by ID. Calls Deel’s documented GET /timesheets/presets/{id} Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the hourly report preset to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_TIME_TRACKING_SHIFT_EXTERNAL_IDGet Shift details. Calls Deel’s documented GET /time_tracking/shifts/{external_id} Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the shift to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_TIME_TRACKING_TIMESHEET_IDRetrieve a timesheet. Calls Deel’s documented GET /time-tracking/timesheets/{timesheet_id} Organization OAuth candidate operation.

Input Parameters

string
Optional list of fields to extend in the response. Currently only file_data is supported, which includes file details (file_id, file_name) and download URL.
string
required
ID of the timesheet to fetch file for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_TIME_TRACKING_TIMESHEETS_UPLOAD_URLInitialize a timesheet CSV upload and return its presigned URL and required form fields. This action does not transfer the CSV: POST it separately with every returned field, and do not send Deel Authorization or x-client-id headers to storage. Calls Deel’s documented POST /time-tracking/timesheets/upload-url Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_USER_IDRetrieve one user from Deel’s SCIM HRIS directory by HRIS profile OID.

Input Parameters

string
required
Unique OID of the HRIS profile to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_VISA_TYPESImmigration visa types. Calls Deel’s documented GET /immigration/visa-types/{country_code} Organization OAuth candidate operation.

Input Parameters

string
required
Alpha 2 country code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_WEBHOOKRetrieve a single webhook. Calls Deel’s documented GET /webhooks/{id} Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the webhook subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_WORKER_ADDITIONAL_FIELDS_EORGet worker additional fields for (EOR). Calls Deel’s documented GET /forms/eor/worker-additional-fields/{country_code} Organization OAuth candidate operation.

Input Parameters

string
required
Country code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_GET_WORKER_RELATION_PROFILE_EXTERNAL_IDFetch Worker Relations of a given HrisProfile by external id. Calls Deel’s documented GET /hris/worker_relations/profile/external/{profile_id} Organization OAuth candidate operation.

Input Parameters

string
required
HrisProfile external ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ADJUSTMENT_CATEGORIESList payroll adjustment categories for selected contract types, defaulting to EOR when contract_types is omitted. Requires an Organization OAuth connection with adjustments:read.

Input Parameters

array
Contract types whose adjustment categories should be returned; defaults to EOR when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_APPLICATION_FEEDBACKSList feedbacks for an application. Calls Deel’s documented GET /ats/applications/{application_id}/feedbacks Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of feedbacks to return per page.
string
Pagination cursor returned by a previous response.
string ("SUBMITTED" | "NOT_SUBMITTED" | "DISMISSED" | "REVOKED")
Filter feedbacks by submission status.
string
required
Unique identifier of the application to retrieve feedbacks for.
boolean
When true, form responses marked as sensitive are omitted from the response. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_APPLICATIONSList one page of ATS applications with candidate, job, stage, source, tag, criteria, and update filters.

Input Parameters

integer
Maximum applications to return.
string
Continuation cursor from the previous page.
string
Job identifier to include.
array
Optional response expansions.
string ("APPLICATION_CREATION_DATE" | "STAGE_CREATION_DATE")
Field by which to sort applications.
string ("ASC" | "DESC")
Application sort order.
string
Search text for filtering applications.
array
Application source slugs to include.
string
Return applications updated after this time.
array
Candidate tag identifiers to include.
array
Archivation reason identifiers to include.
array
Typed job criteria matching filters. Deel receives these as one JSON-encoded query value.
array
Current interview plan stage identifiers to include.
string ("ANY" | "ALL")
Whether any or all candidate tags must match.
string
Return applications moved to their current stage before this time.
array
Current default stage slugs to include.
array
Interview plan stage identifiers ever reached.
array
Current stage category slugs to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_APPLICATION_SOURCESList one page of active ATS application sources.

Input Parameters

integer
Maximum application sources to return.
string
Continuation cursor from the previous page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_ATTACHMENT_FILESList one page of attachment metadata for a specified ATS entity and attachment type.

Input Parameters

integer
Maximum attachments to return.
string
Continuation cursor from the previous page.
string
required
Entity that owns the attachment.
string ("CANDIDATE" | "CAREER_PAGE_SETTING" | "JOB_POSTING" | "NOTE" | "OFFER" | "SENT_CANDIDATE_EMAIL" | "EMAIL_MESSAGE" | "TEMPORARY" | "EMAIL_TEMPLATE" | "JOB_ACTIVITY")
required
Type of entity that owns the attachment.
string ("CV" | "LOGO" | "OFFER_LETTER" | "OTHER")
required
Attachment type to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_CANDIDATESList one page of ATS candidates with job, department, tag, stage, and update filters.

Input Parameters

integer
Maximum candidates to return.
string
Continuation cursor from the previous page.
Search text for filtering candidates.
array
Job identifiers to include.
array
Tag identifiers to include.
string
Return candidates updated after this timestamp.
array
Department identifiers to include.
array
Current default stage slugs to include.
array
Current stage category slugs to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_DEPARTMENTSRetrieve a list of ATS departments. Calls Deel’s documented GET /ats/departments Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records returned in one response
string
Cursor for pagination to get the next set of results
string
If true, archived departments are included in the response; they are excluded by default

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_EMPLOYMENT_TYPESRetrieve a list of ATS employment types. Calls Deel’s documented GET /ats/employment-types Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records returned in one response
string
The cursor for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_HIRESRetrieve a list of ATS hires. Calls Deel’s documented GET /ats/hires Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records to return per page
string
Cursor for pagination. Use the next_cursor value from the previous response to get the next page of results.
string
Return only records updated strictly after this timestamp (ISO 8601 format). Use it to poll for changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_HIRING_MEMBERSRetrieve ATS hiring members. Calls Deel’s documented GET /ats/hiring-members Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records returned in one response
string
The cursor for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_JOB_BOARDSRetrieve a list of ATS job boards. Calls Deel’s documented GET /ats/job-boards Organization OAuth candidate operation.

Input Parameters

integer
Number of items to return
string
Cursor for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_JOB_POSTINGSRetrieve ATS job postings. Calls Deel’s documented GET /ats/job-postings Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of job postings to return per page (min: 1, max: 100).
string
Opaque cursor for pagination. Use the value from next_cursor of the previous response to fetch the next page.
string
When set, only postings for this job are returned (UUID).
string
Job board to list postings from (UUID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_JOBSRetrieve a list of ATS jobs. Calls Deel’s documented GET /ats/jobs Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records returned in one response
string
The cursor for pagination
string
Text to search for in job records (optional)
array
Array of job status values (optional)
array
Array of job UUIDs (optional). Returns only these jobs, so a caller holding job ids from another endpoint can resolve them in one request instead of paging the whole list. Omitting it leaves the result set unchanged.
array
Array of team UUIDs (optional)
array
Array of location UUIDs (optional)
string
Filter jobs updated after this timestamp (ISO 8601 format)
array
Array of department UUIDs (optional)
string
Interview plan UUID (optional)
array
Array of work arrangement values to filter by (optional)
array
Array of employment type UUIDs (optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_LOCATIONSRetrieve a list of ATS locations. Calls Deel’s documented GET /ats/locations Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records returned in one response
string
The cursor for pagination
string
If true, archived locations are included in the response; they are excluded by default

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_OFFERSList ATS offers filtered by application, jobs, or offer statuses.

Input Parameters

array
Job identifiers to include.
array
Offer statuses to include.
string
Application identifier to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_REJECTION_ARCHIVATION_REASONSRetrieve paginated list of ATS Rejection/Archivation reasons. Calls Deel’s documented GET /ats/reasons Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records returned in one response
string
The cursor for pagination
string
Search text for filtering reasons
string ("INTEREST" | "LOCATION" | "COMPENSATION" | "RESPONSIVENESS" | "QUALIFICATION" | "FIT" | "EXPERIENCE" | "STATUS" | "ROLE_CHANGE" | "WITHDREW" | "BENEFITS" | "COUNTER_OFFER" | "REMOTE_WORK" | "PERSONAL" | "TIMING" | "BUDGET" | "BUSINESS_NEEDS" | "EXTERNAL_CANDIDATE" | "INTERNAL_TRANSFER" | "HIRING_FREEZE")
Filter by reason subgroup
string
If true, includes usage counts for each reason
string
If true, archived reasons are included in the response; they are excluded by default
string ("CANDIDATE_ARCHIVATION" | "OFFER_REJECTION" | "JOB_CLOSURE" | "INTERVIEW_CANCELLATION")
required
Filter by reason group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ATS_TEAMSRetrieve a list of ATS teams. Calls Deel’s documented GET /ats/teams Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records returned in one response
string
The cursor for pagination
string
If true, archived teams are included in the response; they are excluded by default

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CASE_INVOICESList case invoices. Calls Deel’s documented GET /immigration/invoices Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of invoices to return. Capped at 100.
string
Opaque pagination cursor returned as next_cursor from a previous response. Omit to fetch the first page.
string
required
The unique identifier of the case whose invoices should be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CASE_NOTESList case notes. Calls Deel’s documented GET /immigration/notes Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of notes to return. Capped at 100.
string
Opaque pagination cursor returned as next_cursor from a previous response. Omit to fetch the first page.
string
required
The unique identifier of the case whose notes should be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CASE_VISA_APPLICATION_QUOTESList case visa application quotes. Calls Deel’s documented GET /immigration/visa-application-quotes Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the eligibility check case.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CLEARANCE_REQUESTSList clearance requests. Calls Deel’s documented GET /it/clearance-requests Organization OAuth candidate operation.

Input Parameters

integer
Return a page of results with given number of records
string
Indicates where the next page of results starts, as returned in a paginated list response
string ("CANCELLED" | "COMPLETED" | "DECIDED" | "PENDING_DECISION" | "PENDING_QUOTE" | "PENDING_RETURN")
Filter clearance requests by their status. Repeat the key to filter on multiple values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CLIENT_CASESList of immigration cases. Calls Deel’s documented GET /immigration/client/cases Organization OAuth candidate operation.

Input Parameters

integer
Max number of results to return
string
Pagination cursor for fetching next set of results
string
Search by applicant name or code
array
Filter by case status
array
Filter by country. Uses ISO 3166-1 alpha-2 codes (https://www.iban.com/country-codes).
array
Filter by case type IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_ADJUSTMENTSRetrieve adjustments. Calls Deel’s documented GET /contracts/{contract_id}/adjustments Organization OAuth candidate operation.

Input Parameters

string
Filter adjustments by end date.
string
Filter adjustments by start date.
string
required
Deel adjustment id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_AMENDMENT_EFFECTIVE_DATE_LIMITATIONSRetrieve Effective Date Limitations. Calls Deel’s documented GET /eor/contracts/{contract_id}/amendments/{amendment_id}/effective-date-limitations Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the EOR worker contract
string
required
A unique identifier for the employee contract amendment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_CUSTOM_FIELD_DEFINITIONSList all custom fields. Calls Deel’s documented GET /contracts/custom_fields Organization OAuth candidate operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_CUSTOM_FIELD_VALUESRetrieve custom fields for a contract. Calls Deel’s documented GET /contracts/{contract_id}/custom_fields Organization OAuth candidate operation.

Input Parameters

string
required
Contract Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_INVOICE_ADJUSTMENTSList a page of a contract’s invoice adjustments, optionally filtered by contract type, adjustment type, status, invoice, reporter, or submission date. Use the returned cursor to continue through results.

Input Parameters

string
Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings
array
types of invoice adjustments to filter
string
Opaque cursor returned by a previous call.
string
Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings
string
To get invoice adjustments submitted before given end date (excludes records submitted on this date). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
array
statuses of invoice adjustment to filter
string
To get invoice adjustments submitted on or after given start date (inclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
string
ID of an existing invoice
string
required
Deel contract id.
string
ID of an existing profile
array
types of contracts to filter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_MILESTONESRetrieve Milestones by Contract. Calls Deel’s documented GET /contracts/{contract_id}/milestones Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the Deel contract for which milestones are being retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_OFFBOARDINGRetrieve Offboarding Request. Calls Deel’s documented GET /eor/contracts/{contract_id}/offboarding Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_OFFBOARDING_RESTRICTED_DATESRetrieve restricted offboarding dates. Calls Deel’s documented GET /eor/contracts/{contract_id}/offboarding/restricted-dates Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the employee contract.
string ("TERMINATION" | "RESIGNATION")
required
Type of offboarding.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_OFFBOARDING_TIME_OFFSRetrieve Employee Time Off Data for Offboarding. Calls Deel’s documented GET /eor/contracts/{contract_id}/offboarding/time-offs Organization OAuth candidate operation.

Input Parameters

string
Desired end date for offboarding
string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_OFF_CYCLE_PAYMENTSList of off-cycle payments. Calls Deel’s documented GET /contracts/{contract_id}/off-cycle-payments Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier (ID) of the Deel contract for which to retrieve off-cycle payments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACTOR_CONTRACT_AMENDMENTSList independent-contractor (IC) contract work-statement amendments, optionally filtered by amendment status or signing status; for EOR contract amendments use DEEL_LIST_EOR_CONTRACT_AMENDMENTS.

Input Parameters

integer
Maximum number of work statements to return.
string
Cursor for pagination.
array
Filter by work statement status.
string
required
Unique identifier of the contract
array
Filter by work statement sign status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_PAYMENT_CYCLESRetrieve contractor payment dates for a contract. The response schema supports active, upcoming, awaiting payment, and overdue cycle statuses; Deel also documents awaiting invoice submission and completed statuses.

Input Parameters

string
required
The Deel contract ID for which payment dates are being retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACTSList organization contract summaries with filters and a continuation cursor. Requires an Organization OAuth connection with contracts:read.

Input Parameters

integer
Maximum contracts to return in this page.
array
Contract types to include.
array
Additional contract fields to include; sent as repeated query values.
string
Match a contract name or contractor name.
string ("contract_title" | "worker_name")
Field used to sort contracts.
array
Return contracts assigned to any of these Deel team IDs.
array
Contract workflow statuses to include.
array
Two-letter uppercase country codes to include.
array
Three-letter uppercase currency codes to include.
string
Return contracts with this external identifier.
string
Continuation cursor returned by the previous call.
Return contracts assigned to any of these legal entity IDs.
string ("asc" | "desc")
Sort in ascending or descending order.
string
Filter by external ID presence using the provider’s string boolean value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_TASKSList of tasks. Calls Deel’s documented GET /contracts/{contract_id}/tasks Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier for the Deel contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_TEMPLATESRetrieve contract templates. Calls Deel’s documented GET /contract-templates Organization OAuth candidate operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_TERMINATION_REASONSList contract termination reasons. Calls Deel’s documented GET /contracts/termination-reasons Organization OAuth candidate operation.

Input Parameters

integer
Number of items to return per page (default: 20, max: 100)
string
Cursor for pagination. Use the value from next_cursor in the previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_TIMESHEET_PRESETSList a contract’s hourly timesheet presets, including each preset’s rate, attached file, and root-preset definition.

Input Parameters

integer
Number of results to return per page
string
Pagination cursor for fetching next set of results
string ("title" | "created_at")
Field to order results by (title or created_at)
string
required
ID of the Deel contract
string ("ASC" | "DESC")
Direction of ordering (ASC or DESC)
string
ID of the work statement (optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CONTRACT_TIMESHEETSList of timesheets by contract. Calls Deel’s documented GET /contracts/{contract_id}/timesheets Organization OAuth candidate operation.

Input Parameters

string
Maximum number of records to return per page. NOTE: query parameters are passed as strings.
string
Opaque cursor returned by a previous call.
string
Number of records to skip before starting to return results. NOTE: query parameters are passed as strings.
string
Filter results to timesheets submitted before this date (exclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
array
Filter results to timesheets with the specified statuses.
string
Filter results to timesheets submitted on or after this date (inclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
string
required
Deel contract id.
string
Filter results to timesheets submitted by this user ID.
array
Filter results to timesheets associated with the specified contract types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_COUNTRIESList countries supported by Deel with EOR, visa, currency, and sub-territory details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CURRENCIESList currencies supported by Deel, including ISO codes and available names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_CURRENT_ON_DEMAND_PAYROLLRetrieve current On-Demand Payroll. Calls Deel’s documented GET /on-demand-payroll/contract/{contract_id}/current Organization OAuth candidate operation.

Input Parameters

string
required
Public ID (oid) of the contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_DEEL_INVOICESRetrieve one page of Deel fee invoices.

Input Parameters

string
Number of invoices to return.
string
Opaque continuation cursor returned by the previous call.
string
Number of invoices to skip before returning this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EOR_BENEFITS_BY_COUNTRYList EOR benefit options for a country and hiring scenario, filtered by visa need, weekly hours, employment type, team, and legal entity.

Input Parameters

string
required
The ID of the team the worker belongs to.
boolean
required
Indicates if work visa is required.
string
required
Country code.
string ("Full-time" | "Part-time")
required
Type of employment
The ID of the legal entity.
number
required
Working hours per week

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EOR_BENEFITS_CONTRACT_IDRetrieve Benefits for EOR Contract. Calls Deel’s documented GET /eor/{contract_id}/benefits Organization OAuth candidate operation.

Input Parameters

string
required
Deel contract ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EOR_CONTRACT_AMENDMENTSList an EOR contract’s amendment history, including statuses, changed values, compensation changes, and legal or rejection context.

Input Parameters

string
required
The unique identifier of EOR worker contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EOR_CONTRACT_DETAILSRetrieve EOR Contract Details. Calls Deel’s documented GET /eor/contracts/{contract_id}/details Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier for the Deel contract

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EOR_CONTRACT_DOCUMENTSList framework-agreement signature metadata for an EOR contract, including client and EOR signer names and signing timestamps.

Input Parameters

string
required
EOR contract ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EOR_WORKER_BENEFITSRetrieve Benefits for Employee. Calls Deel’s documented GET /eor/worker/benefits Organization OAuth candidate operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EOR_WORKER_PAYSLIPSList payslip records for a specified Employer of Record worker.

Input Parameters

string
required
Worker whose payslips to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EQUITY_AMORTIZATIONSList equity grant expense amortization records. Calls Deel’s documented GET /equity-amortizations Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records to return in this page.
string
Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.
string
Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format.
string
Only return records for this exact Shareworks employee number.
string
Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format.
string
Only return records for this exact Shareworks grant number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EQUITY_AWARDSList equity awards granted. Calls Deel’s documented GET /equity-awards Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records to return in this page.
string
Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.
string
Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format.
string
Only return records for this exact Shareworks employee number.
string
Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EQUITY_EXPENSESList equity grant total expense records. Calls Deel’s documented GET /equity-expenses Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records to return in this page.
string
Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.
string
Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format.
string
Only return records for this exact Shareworks employee number.
string
Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format.
string
Only return records for this exact Shareworks grant number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EQUITY_GRANTS_WITH_TAX_EVENTSList equity grants with tax events. Calls Deel’s documented GET /equity-grants Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of grants to return
string
Opaque continuation cursor returned by the previous page.
integer
Number of grants to skip before starting to return results
string
Free-text search across grant/worker name and email

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EQUITY_OPTION_LEDGER_ENTRIESList equity option ledger entries. Calls Deel’s documented GET /equity-option-ledger Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records to return in this page.
string
Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.
string
Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format.
string
Only return records for this exact Shareworks employee number.
string
Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format.
string
Only return records for this exact Shareworks grant number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EQUITY_PARTICIPANTSList equity participants. Calls Deel’s documented GET /equity-participants Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records to return in this page.
string
Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.
string
Only return records for this exact Shareworks employee number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EQUITY_SHAREWORKS_EXERCISESList Shareworks equity exercises. Calls Deel’s documented GET /equity-exercises Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of exercise records to return in this page.
string
Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.
string
Only return exercises for this exact Shareworks employee number.
string
Only return exercises with an exercise_date on or before this date (inclusive), in YYYY-MM-DD format.
string
Only return exercises with an exercise_date on or after this date (inclusive), in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_EQUITY_VALUATIONSList equity grant valuations. Calls Deel’s documented GET /equity-valuations Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records to return in this page.
string
Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page.
string
Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format.
string
Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format.
string
Only return records for this exact Shareworks grant number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_FEEDBACKSList interview and evaluation feedback across the organization. Calls Deel’s documented GET /ats/feedbacks Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of feedback records per page (1-100; 1-50 with include=FORM_RESPONSES).
string
Pagination cursor returned by a previous response.
string ("SUBMITTED" | "NOT_SUBMITTED")
SUBMITTED returns completed scorecards; NOT_SUBMITTED returns feedback still owed by a reviewer.
array
Optional expansions. FORM_RESPONSES embeds the submitted scorecard answers (caps limit at 50).
array
Filter feedback by job IDs.
string ("NEWEST_FIRST" | "OLDEST_FIRST")
Order by feedback creation time.
string ("INTERVIEW_SCHEDULING" | "APPLICATION_EVALUATION" | "EXERCISE" | "QUESTIONNAIRE")
Filter by the kind of activity the feedback belongs to.
array
Filter feedback by candidate IDs.
string
Return feedback updated strictly after this ISO 8601 datetime (incremental sync).
array
Filter feedback by application IDs.
string
Return feedback submitted at or after this ISO 8601 datetime.
string
Return feedback submitted at or before this ISO 8601 datetime.
array
Filter feedback by the scheduled interview it was collected for (ids from GET /rest/ats/interviews).
array
Filter feedback by the interview plan stage of the activity it belongs to (stage ids from GET /rest/ats/jobs/{job_id}/interview-plan-stages).
boolean
When true (default), form responses marked as sensitive are omitted.
array
Filter feedback by the HRIS organization user IDs of the reviewers (interviewers) who owe or submitted it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_GP_CONTRACT_BANK_ACCOUNTSRetrieve bank accounts. Calls Deel’s documented GET /gp/contracts/{contract_id}/banks Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier for a contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_GP_CONTRACT_BANK_GUIDERetrieve bank guide. Calls Deel’s documented GET /gp/contracts/{contract_id}/banks/guide Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier for a contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_GP_REPORT_GROSS_NETList gross-to-net report.. Calls Deel’s documented GET /gp/reports/{id}/gross_to_net Organization OAuth candidate operation.

Input Parameters

string
required
Id of the gp payroll report.
integer
Maximum number of records to return.
string
Opaque continuation cursor returned by the previous call. Omit it for the first page.
integer
Offset/index of record for the next page of records to return.
string
Currency to be used in the report calculation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_GP_WORKER_ADDITIONAL_INFO_FIELDS_BY_COUNTRYList country-specific additional-information fields for Global Payroll workers, including requiredness, validation, dependencies, and UI guidance.

Input Parameters

string
required
ISO 3166-1 alpha-2 country code for which to retrieve GP worker additional fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_GP_WORKER_BANK_GUIDERetrieve bank guide. Calls Deel’s documented GET /gp/workers/{worker_id}/banks/guide Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier for a worker in UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_GP_WORKER_BANKSRetrieve bank accounts. Calls Deel’s documented GET /gp/workers/{worker_id}/banks Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier for a worker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_GP_WORKER_CREATION_SCHEMARetrieve the Global Payroll worker creation schema. Calls Deel’s documented GET /gp/workers/creation-schema Organization OAuth candidate operation.

Input Parameters

string
ISO 3166-1 alpha-2 country of the legal entity. Adds the country rules. Must match the legal entity when legal_entity_id is also given.
Legal entity of your organization. Its country is used and the currencies it may pay in are returned.
string
Payroll group of the legal entity. When it is a Payroll Connect (Soft GP) group, employee_number is reported as required. Requires legal_entity_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_GP_WORKER_PAYSLIPSRetrieve employee payslips. Calls Deel’s documented GET /gp/workers/{id}/payslips Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier for the worker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_GROUPSReturn list of groups. Calls Deel’s documented GET /groups Organization OAuth candidate operation.

Input Parameters

integer
The maximum number of groups to return (between 1 and 100)
string
The encoded cursor for paginated results. This is an opaque string that allows fetching the next set of results.
string ("ASC" | "DESC")
Sort the results in ascending (ASC) or descending (DESC) order based on the group name.
string
Extra information about the group.
boolean
Include archived groups (soft deleted records). Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_HOURLY_REPORT_ROOT_PRESETSList hourly-report root templates, including rate or tracking type, attached files, and contract and derived-preset usage counts.

Input Parameters

integer
Maximum number of items to return per page (max: 100)
string
Pagination cursor for fetching the next page of results
string ("ASC" | "DESC")
Direction to order the results (ascending or descending)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_HRIS_BANK_ACCOUNTSRetrieve HRIS worker bank accounts. Calls Deel’s documented GET /hris/workers/{worker_id}/banks Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier for an HRIS worker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_HRX_DOCUMENTSRetrieve HRX documents. Calls Deel’s documented GET /eor/contracts/{contract_id}/hrx-documents Organization OAuth candidate operation.

Input Parameters

integer
Number of items to return per page. Maximum is 100, default is 20.
string
Cursor for pagination. Use the cursor from the previous response to get the next page of results.
string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_IC_INVOICING_TAXESGet the VAT and withholding-tax percentages applicable to an independent-contractor contract’s invoices.

Input Parameters

string
required
Deel Contract ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_INDUSTRIESList one page of industry subcategories. Calls Deel’s documented GET /industries Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of items to return per page.
string ("ASC" | "DESC")
Sorting order of the results.
string
Cursor used for paginating to the next page of results.
string ("subcategoryName" | "categoryName")
Field used to sort the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_INTERVIEWSList interviews. Calls Deel’s documented GET /ats/interviews Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of interviews to return per page.
string
Pagination cursor returned by a previous response.
array
Filter interviews by status.
array
Filter interviews by job IDs.
string ("SCHEDULED_FIRST" | "NEWEST_FIRST" | "OLDEST_FIRST" | "LATEST_MEETING_FIRST")
Order interviews by upcoming-first, newest-first (by creation), oldest-first, or latest-meeting-first (most recent meeting time, for past-interview views).
array
Filter interviews by candidate IDs.
string
Return interviews updated strictly after this ISO 8601 datetime (incremental sync).
string
Upper bound of interview start time (ISO 8601).
array
Filter interviews by application IDs. When set, every interview of those applications is returned — past, cancelled and on stages the candidate has already moved past — and results default to latest meeting first.
string
Lower bound of interview start time (ISO 8601).
array
Filter interviews by interviewer HRIS organization user IDs.
array
Filter interviews by the interview plan stage the interview belongs to (from GET /rest/ats/jobs interview_plan_stages). When set, every interview on those stages is returned regardless of the candidate’s current stage, and results default to latest meeting first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_INVOICE_ADJUSTMENTSList invoice adjustments. Calls Deel’s documented GET /invoice-adjustments Organization OAuth candidate operation.

Input Parameters

integer
Number of records to return per page.
array
types of invoice adjustments to filter
string
Opaque cursor returned by a previous call.
integer
Zero-based index of the first record to return.
string
To get invoice adjustments submitted before given end date (excludes records submitted on this date). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
array
statuses of invoice adjustment to filter
string
To get invoice adjustments submitted on or after given start date (inclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
string
ID of an existing invoice
string
Id of an Deel contract.
string
ID of an existing profile
array
types of contracts to filter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_INVOICESList one page of organization invoices with status and issue-date filters. Requires an Organization OAuth connection with accounting:read.

Input Parameters

integer
Maximum invoices to return in this page (1-50).
string
Opaque continuation cursor returned by a previous call; omit for the first page.
integer
Index of the first invoice to return.
string
Pass all to include invoices in every status.
string
Pass cor to include invoices from COR workers.
boolean
When true, include invoices from COR workers.
string
Include invoices issued before this date.
string
Include invoices issued on or after this date.
boolean
When true, include invoices in all statuses. When false, Deel returns only paid invoices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_IT_AGREEMENTSList agreements. Calls Deel’s documented GET /it/agreements Organization OAuth candidate operation.

Input Parameters

string ("MANAGEMENT" | "PURCHASE" | "RENTAL")
Filter agreements by type. Repeat the key to filter on multiple values.
integer
Return a page of results with given number of records
string
Indicates where the next page of results starts, as returned in a paginated list response
string ("ACTIVE" | "CANCELED" | "ENDED" | "PENDING")
Filter agreements by status. Repeat the key to filter on multiple values.
string
Filter by the HRIS profile id currently holding the agreement.
string ("COMPLETED" | "IN_PROGRESS" | "READY")
Filter rentals by store-and-reuse status. Repeat the key to filter on multiple values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_IT_ASSETSList IT assets. Calls Deel’s documented GET /it/assets Organization OAuth candidate operation.

Input Parameters

integer
Return a page of results with given number of records
string
Indicates where the next page of results starts, as returned in a paginated list response
string ("ACTIVE" | "ARCHIVED")
Filter assets by their status
string ("ADAPTER" | "CABLE" | "CHAIR" | "CHARGER" | "COMPACT_DESKTOP" | "DESK" | "DESKTOP" | "DESK_RISER" | "DESK_TIDY" | "DOCKING_STATION" | "DONGLE" | "FOOTREST" | "HEADSET" | "KEYBOARD" | "LAPTOP" | "LAPTOP_STAND" | "MICE_TRACKPAD" | "MOBILE_DEVICE" | "MONITOR" | "MONITOR_ARM" | "OTHER" | "PRINTER" | "SHREDDER" | "STANDING_MAT" | "TABLET" | "TASK_LIGHT" | "WEBCAM" | "WELCOME_PACK" | "WIFI_RANGE_EXTENDER")
Filter assets by their product category
string ("AT_WAREHOUSE" | "CLEARANCE_WAREHOUSE" | "DEEL_WAREHOUSE" | "ORGANIZATION_WAREHOUSE" | "SUPPLIER" | "WITH_COURIER" | "WITH_USER" | "WRITE_OFF")
Filter assets by their location
string
Filter assets by assigned worker with given HRIS Profile ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_IT_HARDWARE_POLICIESList IT hardware policies. Calls Deel’s documented GET /it/policies Organization OAuth candidate operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_IT_ORDERSList IT orders. Calls Deel’s documented GET /it/orders Organization OAuth candidate operation.

Input Parameters

integer
Return a page of results with given number of records
string
Indicates where the next page of results starts, as returned in a paginated list response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_IT_POLICY_USERSList users assigned to an IT policy. Calls Deel’s documented GET /it/policies/{policy_id}/users Organization OAuth candidate operation.

Input Parameters

integer
Return a page of results with given number of records
string
Indicates where the next page of results starts, as returned in a paginated list response
string
required
IT policy identifier
string
Filter by the worker’s HRIS Profile ID, to find which policy a specific worker is attached to. Repeat the key to filter on multiple values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_IT_PRODUCTSList products in the catalog. Calls Deel’s documented GET /it/products Organization OAuth candidate operation.

Input Parameters

integer
Return a page of results with given number of records
array
Filter by manufacturer — exact and case-insensitive, repeat for OR semantics. Unlike search it does not substring-match.
string
Indicates where the next page of results starts, as returned in a paginated list response
string
Return products whose name or brand contains this text. Case-insensitive, and partial words match, so ‘book’ finds ‘MacBook Pro’. Only the name and brand are searched — not the description or hardware specification. Use brands for an exact manufacturer match.
string
ISO 3166 alpha-2 country code. Restricts results to products whose variants ship to this country.
string ("ADAPTER" | "CABLE" | "CHAIR" | "CHARGER" | "COMPACT_DESKTOP" | "DESK" | "DESKTOP" | "DESK_RISER" | "DESK_TIDY" | "DOCKING_STATION" | "DONGLE" | "FOOTREST" | "HEADSET" | "KEYBOARD" | "LAPTOP" | "LAPTOP_STAND" | "MICE_TRACKPAD" | "MOBILE_DEVICE" | "MONITOR" | "MONITOR_ARM" | "OTHER" | "PRINTER" | "SHREDDER" | "STANDING_MAT" | "TABLET" | "TASK_LIGHT" | "WEBCAM" | "WELCOME_PACK" | "WIFI_RANGE_EXTENDER")
Filter by product category
array
Restrict results to products approved by any of these IT policies, to see what workers on those policies can order. Repeat for OR semantics. A policy id your organization does not own matches nothing.
boolean
Filter by marketplace sourcing. Organizations without marketplace access never see marketplace products, and the filter is ignored for them rather than emptying the catalog.
string ("NEW" | "REFURBISHED")
Filter by stock condition. Omit to include products of any stock condition.
array
Filter by keyboard layout — repeat for OR semantics
array
Restrict results to products offering at least one of these acquisition types (RENTAL, PURCHASE, REUSE). REUSE represents BYOD (customer-owned) stock. Omit to include all acquisition types the organization is entitled to.
array
Filter by operating system — repeat for OR semantics

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_IT_SEAT_CONTRACTRetrieve the IT seat subscription. Calls Deel’s documented GET /it/seats/status Organization OAuth candidate operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_IT_SEATSList IT seats. Calls Deel’s documented GET /it/seats Organization OAuth candidate operation.

Input Parameters

integer
Return a page of results with given number of records
string
Indicates where the next page of results starts, as returned in a paginated list response
array
Filter seats by their status — repeat the key for OR semantics. Omit to include seats of any status.
array
Filter seats by the HRIS profile holding them — repeat the key for OR semantics. Ids not found in your organization match nothing. Omit to include seats of any worker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_IT_WAREHOUSESList warehouses. Calls Deel’s documented GET /it/warehouses Organization OAuth candidate operation.

Input Parameters

string ("OFFICE" | "RESIDENCE" | "WAREHOUSE")
Filter by organization warehouse type. Repeat the key to filter on multiple values.
integer
Return a page of results with given number of records
string
Indicates where the next page of results starts, as returned in a paginated list response
string
Free-text search on warehouse name
string
Filter by warehouse country (ISO 3166 alpha-2). Repeat the key to filter on multiple values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_JOB_BOARD_POSTINGSRetrieve a list of ATS job postings. Calls Deel’s documented GET /ats/job-boards/{job_board_id}/job-postings Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records returned in one response (optional)
string
The cursor for pagination (optional)
string
required
Job Board ID must be a valid UUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_JOB_INTERVIEW_PLAN_STAGESList interview plan stages of a job with pipeline counts. Calls Deel’s documented GET /ats/jobs/{job_id}/interview-plan-stages Organization OAuth candidate operation.

Input Parameters

string
required
Job whose interview plan stages to list.
array
Optional expansions. CURRENT_APPLICATIONS embeds the most recently moved applications currently sitting in each stage.
integer
Maximum number of current applications embedded per stage when include=CURRENT_APPLICATIONS (1-25).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_JOB_SCOPESList of job scope templates for EOR contracts. Calls Deel’s documented GET /eor/job-scopes Organization OAuth candidate operation.

Input Parameters

string
Team public id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_JOB_TITLESList Deel’s predefined job titles one page at a time.

Input Parameters

string
Cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_LOOKUPSRetrieve SIC numbers, entity types, or countries. For currency tasks, use DEEL_LIST_CURRENCIES. Calls Deel’s documented GET /lookups Organization OAuth candidate operation.

Input Parameters

string ("sicNumbers" | "entityTypes" | "countries")
required
The lookup category to retrieve: sicNumbers, entityTypes, or countries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_MANAGERSRetrieve List of Managers. Calls Deel’s documented GET /managers Organization OAuth candidate operation.

Input Parameters

integer
The number of records to return in the response.
string
Opaque cursor returned by a previous call.
integer
The offset or starting point for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_OFFBOARDING_LISTRetrieve offboarding list. Calls Deel’s documented GET /offboarding/tracker Organization OAuth candidate operation.

Input Parameters

integer
Number of results to return per page (maximum 100; values above this are silently clamped to 100)
string
Continuation cursor returned by the previous call; omit for the first page.
string
Search term to filter contracts by name or other attributes
string
Field to sort by
string
Deprecated. Use cursor instead.
string
Sorting order
array
Filter by hiring type.
boolean
Include an overview of the contract
boolean
Ignore the default 45-day date range and retrieve all terminations
array
Filter by offboarding progress status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ONBOARDING_EMPLOYEESList onboarding employees. Calls Deel’s documented GET /onboarding/tracker Organization OAuth candidate operation.

Input Parameters

string
Narrow the list to the workers one filter card counts. STARTING_THIS_WEEK also needs weekFromDate and weekToDate.
integer
Number of results to return per page. Ignored when cursor is supplied — a cursor already carries the page size and filters of the request that produced it.
array
Search attribute to filter onboarding list by team
string
Continuation cursor returned by the previous call; omit for the first page.
string
Search term to filter contracts by name or other attributes
array
Filter by whether the onboarding is waiting on an action from the client
string
Field to sort by
string
End date for filtering contracts
array
Filter by contract country. Uses ISO 3166-1 alpha-2 codes.
string
Start date for filtering contracts
string
Sorting order
array
Search attribute to filter onboarding list by contract id
array
Search attribute to filter onboarding list by hiring type
string
Last day of the week the STARTING_THIS_WEEK card counts, in the caller’s timezone. On or after weekFromDate
Search attribute to filter onboarding list by legal entity
string
First day of the week the STARTING_THIS_WEEK card counts, in the caller’s timezone
boolean
Include an overview of the contract
array
Search attribute to filter onboarding list by progress status
array
Filter by lifecycle status, the same value each item returns in progress.lifecycle_status
array
Filter by the party the onboarding is waiting on, the same value each item returns in progress.waiting_on
array
Search attribute to filter onboarding list by HRIS direct manager. Expects the manager’s HRIS profile ID, as returned by GET /people in employments[].team.direct_manager_id — not a worker or contract ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ON_DEMAND_PAYROLL_ENTRIESList On-Demand Payroll entries. Calls Deel’s documented GET /on-demand-payroll/contract/{contract_id}/entries Organization OAuth candidate operation.

Input Parameters

string
required
Public ID (oid) of the contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_OPENINGSList job openings. Calls Deel’s documented GET /ats/openings Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of openings to return per page.
string
Pagination cursor returned by a previous response.
array
Filter openings by one or more statuses.
array
Filter openings by linked job IDs.
array
Filter openings by tag IDs.
array
Filter openings by team IDs.
array
Filter openings by location IDs.
string ("ANY" | "ALL")
Operator for tag_ids filter. ‘ANY’ returns openings with at least one matching tag; ‘ALL’ returns openings with all specified tags. Defaults to ‘ANY’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ORGANIZATION_REGISTRATION_DOCUMENTSList Organization Registration Documents. Calls Deel’s documented GET /legal-entities/registration-documents Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of results to return per page.
string
Pagination cursor returned as next_cursor by the previous response. Omit for the first page.
string
Free-text search on the requirement name.
array
Filter by submission status. Repeat the parameter to pass several values.
array
Filter by the product the requirement applies to. Repeat the parameter to pass several values.
boolean
Return superseded submissions instead of the current ones.
array
Filter to specific requirements. Repeat the parameter to pass several values.
Narrow to specific legal entities. Repeat the parameter to pass several values. Omit for every entity you can access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ORGANIZATION_RESOURCESReturn the current Deel organization, teams, departments, or working-location labels. Requires an Organization OAuth connection with organizations:read.

Input Parameters

string ("organization" | "teams" | "departments" | "working_locations")
required
Organization reference resource to return: the current organization, teams, departments, or working-location labels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ORGANIZATION_SECURE_VAULT_FOLDER_ITEMSList Organization Secure Vault Folder Items. Calls Deel’s documented GET /organizations/secure-vault/folders/{folder_id}/items Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of results to return per page.
string
Pagination cursor returned by a previous response.
string
Free-text search on folder and file names.
string
required
Public UUID of the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ORGANIZATION_STRUCTURESGet a page of HRIS organization structures. Continuation is inferred from the requested limit and returned item count, so it may indicate another page when none exists; without a limit, it reports no continuation.

Input Parameters

number
Return a page of results with given number of records.
string
Continuation offset returned by the previous call; omit for the first page.
integer
Return a page of results with given number of records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_ORGANIZATION_TASKSList organization tasks, defaulting to pending tasks. Supports status, category, search and external ID filters with cursor pagination.

Input Parameters

integer
Maximum number of records to return (1-100).
string
Opaque cursor for cursor-based pagination. When provided, use with limit only (do not use offset).
string
Search string for task display name or description.
string ("SETUP" | "EXPENSE_REQUESTS" | "EXPENSES_TO_CLARIFY" | "DOCUMENT_ACTIONS" | "LEGAL_ENTITY_DOCUMENTS" | "OTHER_TASKS" | "DEEL_IT" | "COMPLIANCE" | "PAYMENT_METHODS" | "ACCOUNTING" | "APPROVE_CHILD_ORG_CONTRACT_EDIT")
Filter by task category.
array
Filter by task statuses.
string
Filter by external ID (for tasks created with an external reference).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_PAYMENT_BREAKDOWNRetrieve the accounting breakdown for a Deel payment.

Input Parameters

string
required
Payment ID whose breakdown to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_PAYMENTSList one page of organization payment receipts with date, currency, payer entity, and status filters. This action pins Deel API version 2026-01-01, which remains callable but is deprecated and scheduled to sunset on 2027-07-06. Requires an Organization OAuth connection with accounting:read.

Input Parameters

string
Continuation cursor returned by the previous call; omit for the first page.
string
Include payments created before this date.
array
Payer entity types to include.
array
Payment statuses to include.
string
Include payments created on or after this date.
array
Three-letter uppercase currency codes to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_PAYROLL_CYCLESList payroll cycles. Calls Deel’s documented GET /legal-entities/{legal_entity_id}/payroll-events Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of items to return.
string
Pagination cursor, CUID or UUID format.
string
End date in the format ‘YYYY-MM-DD’. Must not exceed 5 years in the future.
string
Start date in the format ‘YYYY-MM-DD’. Must not be earlier than 5 years ago.
The unique identifier (public ID) for the legal entity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_PEOPLESearch and filter workforce profiles visible to an Organization OAuth connection with people:read.

Input Parameters

integer
Maximum people to return in this page (1-200).
array
Return people associated with any of these Deel team IDs.
string
Opaque continuation cursor returned by the previous call; omit for the first page.
array
Response fields to include; supports the provider’s documented field paths.
integer
Index of the first person to return.
string
Match a person’s name or associated contractor name.
string ("id" | "first_name" | "last_name" | "full_name" | "email" | "country" | "birth_date" | "hiring_type" | "start_date" | "team" | "job_title" | "hiring_status" | "completion_date" | "direct_manager" | "direct_reports_count" | "band_placement" | "comparative_ratio")
Field used to sort people.
string ("asc" | "desc")
Sort direction.
array
Worker hiring types to include.
array
Band placements to include.
array
Hiring statuses to include.
array
Lifecycle statuses to include.
string
Maximum comparative ratio.
string
Minimum comparative ratio.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_PEOPLE_CUSTOM_FIELD_DEFINITIONSList the organization’s people custom-field definitions, including each field’s type, placement, access, applicability, and required/enabled settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_PERSON_CUSTOM_FIELDSRetrieve custom fields for a worker. Calls Deel’s documented GET /people/{worker_id}/custom_fields Organization OAuth candidate operation.

Input Parameters

string
required
Worker id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_PROFILE_TIME_OFF_POLICIESList policies. Calls Deel’s documented GET /time_offs/profile/{hris_profile_id}/policies Organization OAuth candidate operation.

Input Parameters

string
policy type id
string
required
hrisProfileId id.
string
Policy type name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_PUBLISHED_ATS_EMAIL_TEMPLATESRetrieve a list of published ATS email templates. Calls Deel’s documented GET /ats/email-templates Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of email templates to return per page
string
Cursor for pagination. Use the nextCursor value from the previous response to get the next page of results.
string
Return only email templates that were updated after this timestamp (ISO 8601 format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_REFUND_STATEMENT_CREDIT_NOTE_BREAKDOWNRetrieve credit notes linked to a Deel refund statement.

Input Parameters

string
required
Public invoice ID of the refund statement root invoice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_REFUND_STATEMENTSRetrieve one page of Deel refund statements with date, currency, and entity filters.

Input Parameters

string
Cursor returned by the previous call.
string
Include statements created before this date.
array
Legal entity types to include.
string
Include statements created on or after this date.
array
Three-letter uppercase currency codes to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_REQUISITIONSList job requests. Calls Deel’s documented GET /vms/requisitions Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of records to return.
string
Opaque cursor returned by the previous page. Omit to retrieve the first page.
string
Free-text search over the job request title.
array
Filter by job request status.
string ("n_candidates" | "n_positions" | "rate_min" | "rate_max" | "created_at" | "start_date" | "end_date" | "status")
Field to sort by.
array
Filter by ISO 3166-1 alpha-2 country codes.
string ("REMOTE" | "OFFICE" | "HYBRID")
Filter by work mode.
string ("HOURLY" | "MILESTONE" | "DAILY" | "WEEKLY" | "MONTHLY" | "ANNUAL")
Filter by the rate scale of the job request.
string ("ASC" | "DESC")
Sort direction.
array
Filter by talent partner identifiers. The reserved value external_provider matches job requests whose candidates were sourced from an external provider rather than a Deel talent partner.
string
Only return job requests whose end date is on or before this date. Must not be earlier than end_date_from.
string ("GENERAL" | "PENDING_TASKS")
Use PENDING_TASKS to return only the job requests awaiting an action from the token owner.
array
Filter by contract type.
string
Only return job requests created on or before this date. Must not be earlier than created_at_from.
string
Only return job requests whose end date is on or after this date.
string
Only return job requests whose start date is on or before this date. Must not be earlier than start_date_from.
array
Filter by approval status.
string
Only return job requests created on or after this date.
string
Only return job requests whose start date is on or after this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_SENIORITY_LEVELSList Deel’s predefined seniority levels, optionally excluding C-level entries for EOR contracts.

Input Parameters

boolean
Set true to exclude C-level seniorities for EOR contracts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_TAGSList tags. Calls Deel’s documented GET /ats/tags Organization OAuth candidate operation.

Input Parameters

integer
Maximum number of tags to return per page (default: 20, max: 100).
string
Opaque cursor for pagination. Use the value from next_cursor of the previous response to fetch the next page.
string
Filter tags by label (case-insensitive partial match)
string ("true" | "false")
When true, each tag includes candidates_count (number of candidates with that tag)
string
Filter by tag group. Use CANDIDATE for candidate tags.
string
If true, archived tags are included in the response; they are excluded by default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_TIME_OFF_POLICIESList organization time-off policies and resolve policy IDs for auditing or request interpretation. Requires an Organization OAuth connection with time-off:read.

Input Parameters

string
Continuation token returned by the previous call; omit for the first page.
array
Country codes to include.
integer
Maximum policies to return in this page (1-50).
string
Case-insensitive policy name search.
array
Policy type names to include.
array
State or region codes to include.
boolean
Filter by whether a policy has assigned workers.
array
Assigned worker types to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_TIME_OFF_POLICY_VALIDATION_TEMPLATESRetrieve policy validation templates. Calls Deel’s documented GET /time_offs/policy-validation-templates Organization OAuth candidate operation.

Input Parameters

array
required
List of countries (ISO 3166-1 alpha-2 codes) to fetch policy templates and types for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_TIME_OFF_PROFILEList time-off requests. Calls Deel’s documented GET /time_offs/profile/{hris_profile_id} Organization OAuth candidate operation.

Input Parameters

string
Continuation token returned by Deel.
array
Time off status
string
End date of time off
integer
Page size
string
Start date of time off
array
Policy types
array
Time off ids
string
required
HRIS profile id
string
Updated end date
string
Approval end date
array
Filter by policy type names. When omitted, Work Location time-offs are excluded by default. Pass policy_type_names=Work+Location to retrieve only Work Location entries.
string
Updated start date
string
Approval start date

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_TIME_OFF_REQUESTSList one page of time-off requests across the organization with status, date, policy, and deletion filters. Requires an Organization OAuth connection with time-off:read.

Input Parameters

string
Continuation token returned by the previous call; omit for the first page.
array
Time-off statuses to include.
string
Include requests ending on or before this ISO 8601 timestamp.
integer
Requested page size (5-200); Deel may return a different effective size.
string
Include requests starting on or after this ISO 8601 timestamp.
array
Policy type IDs to include.
array
Specific time-off request IDs to return.
string
Include requests updated on or before this ISO 8601 timestamp.
string
Include requests approved on or before this ISO 8601 timestamp.
array
Policy type names to include. Work Location requests are excluded by default unless this filter includes Work Location.
string
Include requests updated on or after this ISO 8601 timestamp.
string
Include requests approved on or after this ISO 8601 timestamp.
boolean
Include soft-deleted time-off requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_TIME_OFF_TYPESList the predefined time-off types available on Deel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_TIMESHEETSList one page of organization timesheets with contract, status, reporter, and submission-date filters. Requires an Organization OAuth connection with timesheets:read.

Input Parameters

integer
Maximum timesheets to return in this page.
string
Continuation cursor returned by a previous call; keep filters unchanged.
integer
Number of timesheets to skip before returning this page.
string
Include timesheets submitted before this date.
array
Timesheet statuses to include.
string
Include timesheets submitted on or after this date.
string
Return timesheets for this Deel contract ID.
string
Return timesheets submitted by this Deel reporter ID.
array
Contract types to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_TIME_TRACKING_SHIFT_RATESRetrieve a Paginated List of Shift Rates. Calls Deel’s documented GET /v2/time_tracking/shift_rates Organization OAuth candidate operation.

Input Parameters

integer
Limit the number of results
string
Opaque cursor returned by a previous call.
integer
Offset for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_TIME_TRACKING_SHIFTSList of shifts. Calls Deel’s documented GET /v2/time_tracking/shifts Organization OAuth candidate operation.

Input Parameters

integer
Limit the number of results
string
Opaque cursor returned by a previous call.
integer
Offset for pagination
string
Filter shifts until this date (YYYY-MM-DD)
string
Filter shifts from this date (YYYY-MM-DD)
array
Filter shifts by one or more contract IDs.
array
Filter shifts by one or more contract IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_USERSList users from Deel’s SCIM HRIS directory. Supports Deel’s documented email equality filter and SCIM startIndex/count pagination parameters.

Input Parameters

string
Maximum results to return. Deel treats 0 as a special case that returns one result.
string
SCIM filter. Deel currently supports the eq operator for email, for example: email eq “person@example.com”.
string
One-based index of the first result; Deel defaults to 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_WEBHOOK_EVENTSList webhook event types. Calls Deel’s documented GET /webhooks/events/types Organization OAuth candidate operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_WEBHOOKSList webhooks using Deel’s GET /webhooks operation. This tool makes a single request and does not expose pagination controls or the next-page cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_WORKER_RELATION_PROFILEList of worker relations. Calls Deel’s documented GET /hris/worker_relations/profile/{hrisProfileOid} Organization OAuth candidate operation.

Input Parameters

string
required
HrisProfile ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_WORKER_RELATION_TYPESRetrieve all worker relation types. Calls Deel’s documented GET /hris/worker_relations/types Organization OAuth candidate operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_LIST_WORK_STATEMENT_PAYMENT_POLICIESList work statement payment policies. Calls Deel’s documented GET /work-statement-payment-policies Organization OAuth candidate operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_REASSIGN_IT_AGREEMENTAssign agreement to a new worker. Calls Deel’s documented POST /it/agreements/{agreement_id}/reassign Organization OAuth candidate operation.

Input Parameters

object
required
Reassignment payload.
string
required
Unique identifier of the agreement

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_REGISTER_FILE_UPLOADInitialize a Deel file upload and return upload targets, required form fields, the file id, and its single-use claim token. This action does not transfer file bytes: upload them separately to each returned presigned URL, include every returned form field unchanged, and do not send Deel Authorization or x-client-id headers to storage. Then pass the claim token only to a matching upload status, completion, or file-claim action. Calls Deel’s documented POST /files Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
Declares the client is multipart-capable. The server returns a multipart response only when the declared size exceeds the configured multipart threshold (MULTIPART_THRESHOLD); otherwise the standard POST form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_REJECT_EOR_QUOTEReject an EOR quote. Calls Deel’s documented PATCH /eor/contracts/{contract_id}/reject Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique identifier of the EOR contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_REVIEW_EOR_OFFBOARDING_PTOSubmit employee resignation PTO review. Calls Deel’s documented POST /eor/contracts/{contract_id}/offboarding/resignations/review-pto Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_REVIEW_MULTIPLE_TASKSReview multiple tasks. Calls Deel’s documented POST /contracts/{contract_id}/tasks/many/reviews Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique Deel contract ID associated with the tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_REVIEW_MULTIPLE_TIMESHEETSReview multiple timesheets. Calls Deel’s documented POST /timesheets/many/reviews Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_REVIEW_TIME_OFF_REQUESTApprove or reject multiple time-off requests. The response separates reviewed requests from those that could not be reviewed.

Input Parameters

array
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_REVIEW_TIME_TRACKING_TIMESHEETReview a submitted timesheet. Calls Deel’s documented POST /time-tracking/timesheets/{timesheet_id}/review Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
ID of the timesheet to review

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_SET_GP_CONTRACT_BANK_SETTINGSSet salary split. Calls Deel’s documented PATCH /gp/contracts/{contract_id}/banks/settings Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier for a contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_SIGN_AMENDMENTSign Amendment. Calls Deel’s documented POST /workers/amendments/{amendment_id}/sign Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.
string
required
The unique identifier of the amendment to sign

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_SIGN_CONTRACT_DOCUMENTSign an EOR contract framework agreement on the client’s behalf using Deel’s contract document signing endpoint.

Input Parameters

object
Documented data request body.
string
required
The type of document. Currently only FRAMEWORK_AGREEMENT is supported.
string
required
EOR contract ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_SIGN_GLOBAL_PAYROLL_AMENDMENTSubmit Global Payroll amendment signature. Calls Deel’s documented POST /contracts/{contract_id}/amendments/{amendment_id}/sign Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique identifier of the Global Payroll contract.
string
required
The unique identifier of the Global Payroll amendment to sign, as returned by POST /rest/contracts/{contract_id}/amendments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_SUBMIT_ON_DEMAND_PAYROLLSubmit On-Demand Payroll. Calls Deel’s documented POST /on-demand-payroll/{odp_id}/submit Organization OAuth candidate operation.

Input Parameters

string
required
Public ID of the On-Demand Payroll.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_SUBMIT_PAYROLL_MIGRATION_IMPORTSubmit a payroll migration import for review. Calls Deel’s documented POST /gp/legal-entities/{legal_entity_id}/payroll-migration-imports/{import_id}/submit Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the payroll migration import to submit, as returned when its files were attached.
The unique identifier of the legal entity the payroll migration import belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_SYNC_TIME_OFF_GLOBAL_PAYROLLSync time-off requests from an external HRIS to Deel Global Payroll, including inserting, updating, or deleting requests. Calls POST /time_offs/global-payroll/sync using Organization OAuth.

Input Parameters

object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_TRANSFER_IT_ASSETAssign asset to new holder. Calls Deel’s documented POST /it/assets/{asset_id}/transfer Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier of the IT asset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UNARCHIVE_ASSETRestore an archived IT asset. Calls Deel’s documented POST /it/assets/{asset_id}/unarchive Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the IT asset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UNASSIGN_WORKERS_FROM_IT_SEATSUnassign up to 100 workers from IT seats in a single all-or-nothing request. Uses an Organization OAuth connection.

Input Parameters

object
required
Workers whose IT seat to release.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_ASSETUpdate an IT asset’s condition grade, purchase date, serial number, end-of-life date, or purchase value. Calls Deel’s PATCH /it/assets/{asset_id} Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier of the IT asset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_ASSET_LOCATIONUpdate asset location. Calls Deel’s documented POST /it/assets/{asset_id}/location Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier of the IT asset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_ATS_APPLICATIONUpdate the source of an ATS application using its application ID.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier of the application to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_ATS_CANDIDATEUpdate ATS Candidate. Calls Deel’s documented PATCH /ats/candidates/{candidate_id} Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier of the candidate to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_CONTRACT_ADJUSTMENTPartially update an existing Deel payroll or EOR adjustment, optionally replacing its receipt file.

Input Parameters

string
required
Deel adjustment identifier.
object
required
Adjustment fields to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_CONTRACT_AMENDMENTUpdate amendment. Calls Deel’s documented PATCH /eor/contracts/{contract_id}/amendments/{amendment_id} Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique identifier of EOR worker contract.
string
required
A unique identifier for the employee contract amendment. This string is either supplied by the client or generated by the system and is used to uniquely identify the amendment during upsert operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_CONTRACT_CUSTOM_FIELDReplace a contract’s custom-field values using one custom-field value per request; values omitted from the request are removed.

Input Parameters

object
required
Complete set of contract custom-field values. Each item identifies the custom-field definition and supplies the value shape for its field type.
string
required
Contract id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_CONTRACT_EMPLOYEE_INFORMATIONUpdate the employee’s first and/or last name for an EOR contract.

Input Parameters

object
required
Documented data request body.
string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_CONTRACT_PLATFORM_PAYMENT_TYPEUpdate contract payment type. Calls Deel’s documented PATCH /contracts/{contract_id}/platform-payment Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier of the contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_CURRENT_PERSONAL_PROFILEUpdate the authenticated user’s personal profile fields, including name, phone, preferred currency, and timezone.

Input Parameters

object
required
Profile fields to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_EMPLOYMENT_TYPE_CONTRACTUpdate employment type for a contract. Calls Deel’s documented PATCH /gp/contracts/{contract_id}/employment-type Organization OAuth candidate operation.

Input Parameters

object
required
Employment-type change details, including the effective date.
string
required
The unique identifier of the GP contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_END_DATE_CONTRACTUpdate end date for a contract. Calls Deel’s documented PATCH /gp/contracts/{contract_id}/end-date Organization OAuth candidate operation.

Input Parameters

object
required
End date change details, including the effective date.
string
required
The unique identifier of the GP contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_EOR_CONTRACTReplace the editable details of an EOR contract. Include job_title, start_date, employee_first_name, employee_last_name, employee_email, employment_country, and employment_type even when changing only one field. Calls Deel’s documented PATCH /eor/contract/{contract_id} Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_GP_CONTRACT_BANK_ACCOUNTPartially update one bank account for a specific Global Payroll contract without affecting the worker’s other contracts.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier for the bank account in UUID format.
string
required
Unique identifier for a contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_GP_WORKER_ADDITIONAL_INFORMATIONUpdate GP worker additional information. Calls Deel’s documented PATCH /gp/workers/contracts/{contract_id}/additional-information Organization OAuth candidate operation.

Input Parameters

object
required
Additional-information values keyed by public API field key.
string
required
The unique public identifier of the contract.
object
Documented effective_dates request body.
boolean
Pass true to receive a 200 response with is_additional_data_done and missing_keys instead of the default 204 No Content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_GP_WORKER_ADDRESSUpdate address. Calls Deel’s documented PATCH /gp/workers/{worker_id}/address Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier for a worker in UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_GP_WORKER_BANKModify bank account. Calls Deel’s documented PATCH /gp/workers/{worker_id}/banks/{bank_id} Organization OAuth candidate operation.

Input Parameters

string
Documented city request body.
string
Documented iban request body.
string
Documented email request body.
string
Documented phone request body.
string
Documented postal request body.
string
Documented tax_id request body.
string
required
Unique identifier for the bank account in UUID format.
string
Documented bank_code request body.
string
Documented bank_name request body.
string
Documented full_name request body.
string
Documented swift_bic request body.
string
required
Unique identifier for a worker in UUID format.
string
Documented rib_number request body.
string
Documented branch_code request body.
string
Documented account_type request body.
string
Documented country_code request body.
string
Documented address_line1 request body.
string
Documented address_line2 request body.
string
Documented currency_code request body.
string
Documented original_name request body.
string
Documented account_number request body.
string
Documented province_state request body.
string
Documented bank_branch_name request body.
string
Documented bank_country_code request body.
string
Documented ach_routing_number request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_GP_WORKER_COMPENSATIONUpdate compensation. Calls Deel’s documented PATCH /gp/workers/{worker_id}/compensation Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier for a worker in UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_GP_WORKER_EMPLOYEE_INFORMATIONUpdate a Global Payroll worker’s employee number. Calls Deel’s PATCH /gp/workers/{worker_id}/employee-information operation using Organization OAuth.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier for a worker in UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_GP_WORKER_PTO_POLICYUpdate PTO policy. Calls Deel’s documented PATCH /gp/workers/{worker_id}/pto-policy Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier for a worker in UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_GROUPUpdate a group’s name. Calls Deel’s PATCH /groups/{id} operation using Organization OAuth.

Input Parameters

string
required
Unique identifier of the group to be edited.
object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_IC_CONTRACTAdd external Id. Calls Deel’s documented PATCH /contracts/{contract_id} Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Deel contract id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_IC_INVOICING_TAXUpdate IC invoicing tax. Calls Deel’s documented PATCH /contracts/{contract_id}/ic-invoicing-taxes Organization OAuth candidate operation.

Input Parameters

object
required
IC invoicing tax fields to update on the contract.
string
required
Deel Contract ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_INVOICE_ADJUSTMENTUpdate an invoice adjustment. Calls Deel’s documented PATCH /invoice-adjustments/{id} Organization OAuth candidate operation.

Input Parameters

string
required
Invoice adjustment id.
object
required
Details of adjustment to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_ORGANIZATION_ROLEUpdate organization custom role. Calls Deel’s documented PATCH /roles/{roleId} Organization OAuth candidate operation.

Input Parameters

object
Documented data request body.
string
required
ID of the role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_ORGANIZATION_SECURE_VAULT_FOLDERUpdate Organization Secure Vault Folder. Calls Deel’s documented PATCH /organizations/secure-vault/folders/{folder_id} Organization OAuth candidate operation.

Input Parameters

object
required
Fields to update on the folder.
string
required
Public UUID of the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_ORGANIZATION_STRUCTUREUpdate an existing HRIS Org Structure. Calls Deel’s documented PATCH /hris/organization_structures/{hris_org_structure_id} Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Org Structure

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_ORGANIZATION_STRUCTURE_EXTERNAL_IDUpdate an existing HRIS Org Structure by external ID. Calls Deel’s documented PATCH /hris/organization_structures/external/{external_id} Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
External ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_PERSON_CUSTOM_FIELDCreate or overwrite one custom-field value for a worker.

Input Parameters

object
required
One worker custom-field value, identifying the custom-field definition and supplying the value shape for its field type.
string
required
Worker ID in UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_PERSON_DEPARTMENTUpdate organization structure. Calls Deel’s documented PUT /people/{id}/department Organization OAuth candidate operation.

Input Parameters

string
required
Hris profile ID
object
required
Documented data request body.
boolean
Indicates if this department position should replace all other positions or only append to the existing ones.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_PERSON_PERSONAL_INFOUpdate personal information. Calls Deel’s documented PATCH /people/{worker_id}/personal Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier for a worker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_PERSON_PERSONAL_INFO_EXTERNAL_IDUpdate personal information by external id. Calls Deel’s documented PATCH /people/external/{worker_id}/personal Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier for a worker (External ID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_PERSON_WORKING_LOCATIONUpdate working location. Calls Deel’s documented PUT /people/{id}/working-location Organization OAuth candidate operation.

Input Parameters

string
required
Hris profile ID
object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_SHIFT_RATE_BY_EXTERNAL_IDUpdate a shift rate’s name, type, or value by external ID; Deel rejects updates while any shift references the rate.

Input Parameters

object
required
Shift-rate fields to update.
string
required
Unique identifier of the shift rate to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_TASK_IDUpdate Task By ID. Calls Deel’s documented PATCH /tasks/{task_id} Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The id of an existing task

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_TIME_OFF_REQUESTUpdate time-off request. Calls Deel’s documented PATCH /time_offs/{time_off_id} Organization OAuth candidate operation.

Input Parameters

object
required
Time off update request data
string
required
Time off request id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_TIMESHEET_ENTRYUpdate a timesheet entry. Calls Deel’s documented PATCH /timesheets/{timesheet_id} Organization OAuth candidate operation.

Input Parameters

object
required
Fields to update on the existing timesheet entry.
string
required
ID of an existing timesheet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_TIMESHEETS_PRESETUpdate Hourly Report Preset. Calls Deel’s documented PATCH /timesheets/presets/{id} Organization OAuth candidate operation.

Input Parameters

string
required
The unique identifier of the hourly report preset to update
object
required
Documented data request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_TIME_TRACKING_SHIFT_EXTERNAL_IDUpdate a shift. Calls Deel’s documented PATCH /time_tracking/shifts/{external_id} Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Unique identifier of the shift to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_WEBHOOKUpdate a webhook. Calls Deel’s documented PATCH /webhooks/{id} Organization OAuth candidate operation.

Input Parameters

string
required
Unique identifier of the webhook subscription.
string
Documented url request body.
string
Documented name request body.
array
Documented events request body.
string ("enabled" | "disabled")
Status of webhook.
string
Documented description request body.
boolean
Documented include_child_orgs request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_WORKER_RELATION_TYPEUpdate a worker relation type. Calls Deel’s documented PATCH /hris/worker_relations/types/{typeId} Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Worker Relation Type id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPDATE_WORKER_RELATION_TYPE_EXTERNAL_IDUpdate a worker relation type by external id. Calls Deel’s documented PATCH /hris/worker_relations/types/external/{externalId} Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
Worker Relation Type external ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPLOAD_ORGANIZATION_SECURE_VAULT_FILESUpload files to the Organization Secure Vault root. Each upload claim token must come from Deel’s POST /files response for the matching file_id; it claims only that initialized file. Calls Deel’s documented POST /organizations/secure-vault/files Organization OAuth candidate operation.

Input Parameters

object
required
The files to attach to the Organization Secure Vault.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPLOAD_ORGANIZATION_SECURE_VAULT_FILES_FOLDERUpload files to an Organization Secure Vault folder. Each upload claim token must come from Deel’s POST /files response for the matching file_id; it claims only that initialized file. Calls Deel’s documented POST /organizations/secure-vault/folders/{folder_id}/files Organization OAuth candidate operation.

Input Parameters

object
required
The files to attach to the Organization Secure Vault.
string
required
Public UUID of the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_UPLOAD_VENDOR_BILL_ATTACHMENTUpload a PDF attachment of up to 8 MB to an existing Deel vendor bill.

Input Parameters

object
required
PDF attachment, with a maximum size of 8 MB.
string
required
Vendor bill UUID to attach the PDF to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_VALIDATE_EOR_AMENDMENTSValidate amendment data points. Calls Deel’s documented POST /eor/contracts/{contract_id}/amendments/validate Organization OAuth candidate operation.

Input Parameters

object
required
Documented data request body.
string
required
The unique identifier of the employee contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_VALIDATE_JOB_SCOPERequest job scope validation. Calls Deel’s documented POST /eor/job-scopes/validate Organization OAuth candidate operation.

Input Parameters

object
required
details of job scope

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEEL_VALIDATE_TIME_OFFValidate time-off request. Calls Deel’s documented POST /time_offs/validate Organization OAuth candidate operation.

Input Parameters

object
required
Time off request data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not