Deel MCP connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'deelmcp'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Deel MCP:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'deelmcp_advance_eligibility_get',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "deelmcp"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Deel MCP:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="deelmcp_advance_eligibility_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• Trigger workflow, workflow action — Creates an internal invisible workflow with a trigger
• Get worker personal info external, worker hrx manager, verification method — Retrieves a worker profile record using a system-wide external worker identifier
• List worker document, worker contract type, worker compliance document — Retrieve a list of documents of a worker
• Download worker document, invoice, ic invoice — Get the download link of worker document
• Sign worker contract, worker amendment, eor resignation letter — Records the worker’s signature on the contract identified by contract_id
• Update vms candidate, worker relation type external id, worker relation type — Handles a candidate action event from an external provider by updating the candidate state and triggering corresponding platform workflows

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

deelmcp_advance_eligibility_get#Checks whether the authenticated contractor is eligible for a Deel Advance. Evaluates KYC verification, contract type, payment cycle status, termination proximity, and organization standing, returning a detailed breakdown.0 params▾

Checks whether the authenticated contractor is eligible for a Deel Advance. Evaluates KYC verification, contract type, payment cycle status, termination proximity, and organization standing, returning a detailed breakdown.

deelmcp_ap_vendor_bill_create#Creates a new vendor bill in accounts payable, associating it with your organization. Attachments can be added to the bill via a subsequent call using the returned id.1 param▾

Creates a new vendor bill in accounts payable, associating it with your organization. Attachments can be added to the bill via a subsequent call using the returned id.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_approve_or_reject_external_candidate_interview_response#Use this endpoint to process a candidate's interview decision received from an external provider. Provide the job and candidate identifiers and the action to approve or reject the interview. The system records the decision and updates the candidate's1 param▾

Use this endpoint to process a candidate's interview decision received from an external provider. Provide the job and candidate identifiers and the action to approve or reject the interview. The system records the decision and updates the candidate's

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_ats_application_feedback_list#Returns a paginated list of feedbacks submitted for activities on the given application, including reviewer profiles, overall recommendations, and form responses.5 params▾

Returns a paginated list of feedbacks submitted for activities on the given application, including reviewer profiles, overall recommendations, and form responses.

NameTypeRequiredDescription

application_idstringrequiredUnique identifier of the application to retrieve feedbacks for.

cursorstringoptionalPagination cursor returned by a previous response.

limitintegeroptionalMaximum number of feedbacks to return per page.

should_hide_sensitive_fieldsbooleanoptionalWhen true, form responses marked as sensitive are omitted from the response. Defaults to true.

statusstringoptionalFilter feedbacks by submission status.

deelmcp_ats_application_sources_list#Returns the available application sources in the Applicant Tracking System.2 params▾

Returns the available application sources in the Applicant Tracking System.

NameTypeRequiredDescription

cursorstringoptionalThe cursor for pagination

limitintegeroptionalMaximum number of records returned in one response

deelmcp_ats_applications_create#Creates a new ATS application linking an existing candidate to an existing job. Both the candidate and job must exist prior to this call; the returned id can be used for subsequent operations such as adding notes or associating interview stages.1 param▾

Creates a new ATS application linking an existing candidate to an existing job. Both the candidate and job must exist prior to this call; the returned id can be used for subsequent operations such as adding notes or associating interview stages.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_ats_applications_get#Retrieves a single application by its application_id, including associated job details, job posting details, and related metadata.1 param▾

Retrieves a single application by its application_id, including associated job details, job posting details, and related metadata.

NameTypeRequiredDescription

application_idstringrequiredUnique identifier of the application to retrieve

deelmcp_ats_applications_interview_plan_create#Associates an application with an interview plan stage. Set `is_current_stage` to control active vs historical entry. Supports selective activity triggers and candidate archivation with optional rejection email.2 params▾

Associates an application with an interview plan stage. Set `is_current_stage` to control active vs historical entry. Supports selective activity triggers and candidate archivation with optional rejection email.

NameTypeRequiredDescription

application_idstringrequiredID of the application to be associated with the interview plan stage

dataobjectrequiredNo description.

deelmcp_ats_applications_list#Returns a cursor-paginated list of candidate applications across all open positions for the organization, with filtering by job, interview plan stage, candidate tags, source, stage type, and last-updated timestamp.13 params▾

Returns a cursor-paginated list of candidate applications across all open positions for the organization, with filtering by job, interview plan stage, candidate tags, source, stage type, and last-updated timestamp.

NameTypeRequiredDescription

candidate_tag_idsarrayoptionalFilter applications by candidate tag IDs

current_stage_category_type_slugsarrayoptionalFilter applications by current stage category type slugs

current_stage_default_type_slugsarrayoptionalFilter applications by current stage default type slugs. Use 'others' for custom stages.

cursorstringoptionalCursor for pagination. Use the nextCursor value from the previous response to get the next page of results.

interview_plan_stage_idsarrayoptionalFilter applications by specific interview plan stage IDs

job_criterias_matchingsarrayoptionalFilter applications by job criteria matching state. Each object specifies a job criteria ID and whether the candidate matches it.

job_idstringoptionalFilter applications by specific job ID

limitintegeroptionalMaximum number of applications to return per page

search_textstringoptionalSearch text to filter applications by candidate name or email

sort_bystringoptionalField to sort applications by

sort_orderstringoptionalSort order for applications

source_slugsarrayoptionalFilter applications by source slugs

updated_afterstringoptionalFilter applications updated after this timestamp (ISO 8601 format)

deelmcp_ats_applications_notes_create#Adds a note to a specific application. The `author_id` must correspond to a valid HRIS user.2 params▾

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

NameTypeRequiredDescription

application_idstringrequiredId of the application which the note will be added

dataobjectrequiredNo description.

deelmcp_ats_attachments_get#Lists attachment files for a specific ATS entity, scoped by `attachable_type_slug`, `attachable_id`, and `attachment_type_slug`.5 params▾

Lists attachment files for a specific ATS entity, scoped by `attachable_type_slug`, `attachable_id`, and `attachment_type_slug`.

NameTypeRequiredDescription

attachable_idstringrequiredUnique identifier for the attachable entity

attachable_type_slugstringrequiredType of the attachable entity

attachment_type_slugstringrequiredType of the attachment

cursorstringoptionalThe cursor for pagination

limitintegeroptionalMaximum number of records returned in one response

deelmcp_ats_candidate_create#Creates a candidate record for contractor onboarding outside of an ATS flow. The returned record can be used in subsequent contract creation calls.1 param▾

Creates a candidate record for contractor onboarding outside of an ATS flow. The returned record can be used in subsequent contract creation calls.

NameTypeRequiredDescription

dataobjectrequiredDetails of candidate to create

deelmcp_ats_candidates_create#Creates a new candidate record in the ATS and returns the candidate with their unique identifier, which can then be used to link the candidate to job applications.1 param▾

Creates a new candidate record in the ATS and returns the candidate with their unique identifier, which can then be used to link the candidate to job applications.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_ats_candidates_list#Returns a paginated list of candidates, optionally filtered by job IDs, department IDs, tag IDs, current stage category or default type slugs, or a timestamp to return only records updated after a given point.9 params▾

Returns a paginated list of candidates, optionally filtered by job IDs, department IDs, tag IDs, current stage category or default type slugs, or a timestamp to return only records updated after a given point.

NameTypeRequiredDescription

current_stage_category_type_slugsarrayoptionalFilter candidates by current stage category type slugs

current_stage_default_type_slugsarrayoptionalFilter candidates by current stage default type slugs

cursorstringoptionalThe cursor for pagination

department_idsarrayoptionalFilter candidates by department IDs

job_idsarrayoptionalFilter candidates by job IDs

limitintegeroptionalMaximum number of records returned in one response

searchstringoptionalSearch text for filtering candidates

tag_idsarrayoptionalFilter candidates by tag IDs

updated_afterstringoptionalFilter applications updated after this timestamp (ISO 8601 format)

deelmcp_ats_candidates_tags_create#Replaces all existing tags on a candidate with the provided set of `tag_ids`. This is a full replacement — any tags not included in the request body will be removed.2 params▾

Replaces all existing tags on a candidate with the provided set of `tag_ids`. This is a full replacement — any tags not included in the request body will be removed.

NameTypeRequiredDescription

candidate_idstringrequiredThe unique identifier of the candidate.

tag_idsarrayrequiredList of tag IDs to associate with the candidate

deelmcp_ats_departments_list#Returns a paginated list of all departments configured in the ATS.2 params▾

Returns a paginated list of all departments configured in the ATS.

NameTypeRequiredDescription

cursorstringoptionalThe cursor for pagination

limitintegeroptionalMaximum number of records returned in one response

deelmcp_ats_email_templates_list#Returns a paginated list of published email templates for the organization, supporting cursor-based pagination and filtering by `updated_after` timestamp.3 params▾

Returns a paginated list of published email templates for the organization, supporting cursor-based pagination and filtering by `updated_after` timestamp.

NameTypeRequiredDescription

cursorstringoptionalCursor for pagination. Use the nextCursor value from the previous response to get the next page of results.

limitintegeroptionalMaximum number of email templates to return per page

updated_afterstringoptionalReturn only email templates that were updated after this timestamp (ISO 8601 format)

deelmcp_ats_employment_types_list#Returns a paginated list of employment types available in the ATS.2 params▾

Returns a paginated list of employment types available in the ATS.

NameTypeRequiredDescription

cursorstringoptionalThe cursor for pagination

limitintegeroptionalMaximum number of records returned in one response

deelmcp_ats_hiring_members_list#Returns a paginated list of hiring members configured in the ATS.2 params▾

Returns a paginated list of hiring members configured in the ATS.

NameTypeRequiredDescription

cursorstringoptionalThe cursor for pagination

limitintegeroptionalMaximum number of records returned in one response

deelmcp_ats_job_boards_job_list#Returns a paginated list of job postings belonging to the specified job board. Results can be filtered using available query parameters.3 params▾

Returns a paginated list of job postings belonging to the specified job board. Results can be filtered using available query parameters.

NameTypeRequiredDescription

job_board_idstringrequiredJob Board ID must be a valid UUID

cursorstringoptionalThe cursor for pagination (optional)

limitintegeroptionalMaximum number of records returned in one response (optional)

deelmcp_ats_job_boards_list#Retrieves a list of job boards in the Applicant Tracking System2 params▾

Retrieves a list of job boards in the Applicant Tracking System

NameTypeRequiredDescription

cursorstringoptionalCursor for pagination

limitintegeroptionalNumber of items to return

deelmcp_ats_job_postings_get#Returns a single job posting by `job_posting_id`, including its associated job object, publication status, application form configuration, compensation visibility flag, and rich-text description.1 param▾

Returns a single job posting by `job_posting_id`, including its associated job object, publication status, application form configuration, compensation visibility flag, and rich-text description.

NameTypeRequiredDescription

job_posting_idstringrequiredUnique identifier of the job posting to retrieve

deelmcp_ats_job_postings_list#Use this endpoint to retrieve job postings by specifying the job board ID or job ID. It provides detailed postings with job details, publication status, and relevant metadata.4 params▾

Use this endpoint to retrieve job postings by specifying the job board ID or job ID. It provides detailed postings with job details, publication status, and relevant metadata.

NameTypeRequiredDescription

cursorstringoptionalOpaque cursor for pagination. Use the value from next_cursor of the previous response to fetch the next page.

job_board_idstringoptionalJob board to list postings from (UUID).

job_idstringoptionalWhen set, only postings for this job are returned (UUID).

limitintegeroptionalMaximum number of job postings to return per page (min: 1, max: 100).

deelmcp_ats_jobs_create#Creates a new job in the ATS and returns the resulting job record, including its assigned `id`, initial status, and associated approval rule and request identifiers.1 param▾

Creates a new job in the ATS and returns the resulting job record, including its assigned `id`, initial status, and associated approval rule and request identifiers.

NameTypeRequiredDescription

dataobjectoptionalNo description.

deelmcp_ats_jobs_list#Returns a paginated list of jobs in the ATS, filterable by text search, interview plan, locations, teams, employment types, departments, status values, and an ISO 8601 `updated_after` timestamp.10 params▾

Returns a paginated list of jobs in the ATS, filterable by text search, interview plan, locations, teams, employment types, departments, status values, and an ISO 8601 `updated_after` timestamp.

NameTypeRequiredDescription

cursorstringoptionalThe cursor for pagination

department_idsarrayoptionalArray of department UUIDs (optional)

employment_type_idsarrayoptionalArray of employment type UUIDs (optional)

interview_plan_idstringoptionalInterview plan UUID (optional)

limitintegeroptionalMaximum number of records returned in one response

location_idsarrayoptionalArray of location UUIDs (optional)

searchstringoptionalText to search for in job records (optional)

statusarrayoptionalArray of job status values (optional)

team_idsarrayoptionalArray of team UUIDs (optional)

updated_afterstringoptionalFilter jobs updated after this timestamp (ISO 8601 format)

deelmcp_ats_locations_list#Returns a paginated list of all work locations associated with the organization, suitable for use when constructing job postings or filtering by location.2 params▾

Returns a paginated list of all work locations associated with the organization, suitable for use when constructing job postings or filtering by location.

NameTypeRequiredDescription

cursorstringoptionalThe cursor for pagination

limitintegeroptionalMaximum number of records returned in one response

deelmcp_ats_offers_list#Returns all offers associated with the organization, including worker type and offer status, to support pre-onboarding and contract creation workflows.1 param▾

Returns all offers associated with the organization, including worker type and offer status, to support pre-onboarding and contract creation workflows.

NameTypeRequiredDescription

application_idstringoptionalFilter offers by a specific application ID

deelmcp_ats_reasons_list#Returns a paginated list of rejection and archivation reasons, filterable by `reason_group_slug` and `subgroup_slug`; when `include_counts` is true, each reason includes a usage count.6 params▾

Returns a paginated list of rejection and archivation reasons, filterable by `reason_group_slug` and `subgroup_slug`; when `include_counts` is true, each reason includes a usage count.

NameTypeRequiredDescription

cursorstringoptionalThe cursor for pagination

include_countsstringoptionalIf sent true, it will fetch result with counts

limitintegeroptionalMaximum number of records returned in one response

reason_group_slugstringoptionalReason group enum

searchstringoptionalSearch text for filtering candidates

subgroup_slugstringoptionalReason subgroup enum

deelmcp_ats_tags_list#Returns a paginated list of tags associated with the organization, filterable by label and `tag_group_slug`; when `include_counts` is true, each tag includes a count of associated candidates.5 params▾

Returns a paginated list of tags associated with the organization, filterable by label and `tag_group_slug`; when `include_counts` is true, each tag includes a count of associated candidates.

NameTypeRequiredDescription

cursorstringoptionalOpaque cursor for pagination. Use the value from next_cursor of the previous response to fetch the next page.

include_countsstringoptionalWhen true, each tag includes candidates_count (number of candidates with that tag)

limitintegeroptionalMaximum number of tags to return per page (default: 20, max: 100).

search_textstringoptionalFilter tags by label (case-insensitive partial match)

tag_group_slugstringoptionalFilter by tag group. Use CANDIDATE for candidate tags.

deelmcp_bank_contractor_bank_transfer_requirements_get#Returns the field requirements for creating a bank transfer method for the specified country and currency combination, including fee information calculated against the provided amount or a default of 100.00.3 params▾

Returns the field requirements for creating a bank transfer method for the specified country and currency combination, including fee information calculated against the provided amount or a default of 100.00.

NameTypeRequiredDescription

countrystringrequiredCountry code

currencystringrequiredCurrency code

amountnumberoptionalAmount for calculating fees, if not provided, the default amount of 100.00 is used

deelmcp_bank_employee_transfer_requirements_get#Returns progressive field requirements for configuring a bank transfer payout method. Submit iteratively until `is_final` is `true`, then call `POST /payouts/employees/methods` to create the method.1 param▾

Returns progressive field requirements for configuring a bank transfer payout method. Submit iteratively until `is_final` is `true`, then call `POST /payouts/employees/methods` to create the method.

NameTypeRequiredDescription

dataobjectoptionalRequest data

deelmcp_benefit_401k_activate#Activates the 401k benefits integration for the specified legal entity. Must be called before 401k plans can be created or employees enrolled.1 param▾

Activates the 401k benefits integration for the specified legal entity. Must be called before 401k plans can be created or employees enrolled.

NameTypeRequiredDescription

idstringrequiredId from the legal entity to activate 401k integration

deelmcp_benefit_401k_enrollment_create#Enrolls a contract in a 401(k) plan, setting contribution rates and election details. The referenced plan must be active and created via `POST /benefits/legal-entities/{legal_entity_id}/401k/plans` before enrollment can proceed.8 params▾

Enrolls a contract in a 401(k) plan, setting contribution rates and election details. The referenced plan must be active and created via `POST /benefits/legal-entities/{legal_entity_id}/401k/plans` before enrollment can proceed.

NameTypeRequiredDescription

contract_idstringrequiredContract id from the employee

contribution_limitnumberrequiredMaximum limit of contribution.

legal_entity_idstringrequiredLegal entity id which employee/contract belongs

plan_idstringrequiredPlan id to enroll the employee into

typestringrequiredType of the contribution for 401k.

contribution_typestringoptionalType of contribution.

contribution_valuenumberoptionalValue of the contribution.

detailsobjectoptionalObject containing additional information about the enrollment.

deelmcp_benefit_401k_enrollment_delete#Removes the enrollment settings for an employee, from a specific 401k plan.4 params▾

Removes the enrollment settings for an employee, from a specific 401k plan.

NameTypeRequiredDescription

contract_idstringrequiredContract id from the employee

idstringrequiredLegal entity id which employee/contract belongs

plan_idstringrequiredPlan id to enroll the employee into

typestringrequiredType of the contribution for 401k.

deelmcp_benefit_401k_enrollment_get#Returns the current enrollment settings for an employee, within a specific 401k plan.3 params▾

Returns the current enrollment settings for an employee, within a specific 401k plan.

NameTypeRequiredDescription

contract_idstringrequiredContract id from the employee

legal_entity_idstringrequiredLegal entity id which employee/contract belongs

plan_idstringrequiredPlan id to enroll the employee into

deelmcp_benefit_401k_enrollment_update#Replaces all enrollment settings for a contract's existing 401(k) plan enrollment. As a PUT operation, the full set of enrollment fields must be supplied; omitted fields will not be preserved from the prior state.8 params▾

Replaces all enrollment settings for a contract's existing 401(k) plan enrollment. As a PUT operation, the full set of enrollment fields must be supplied; omitted fields will not be preserved from the prior state.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract

legal_entity_idstringrequiredLegal entity id which employee/contract belongs

plan_idstringrequiredPlan id to enroll the employee into

contribution_limitnumberoptionalMaximum limit of contribution.

contribution_typestringoptionalType of contribution.

contribution_valuenumberoptionalValue of the contribution.

detailsobjectoptionalObject containing additional information about the enrollment.

typestringoptionalType of the contribution for 401k.

deelmcp_benefit_401k_plan_clean_up#Triggers a cleanup of 401k plan data for the specified legal entity.1 param▾

Triggers a cleanup of 401k plan data for the specified legal entity.

NameTypeRequiredDescription

idstringrequiredId from the legal entity to clean up

deelmcp_benefit_401k_plan_create#Creates a new 401k plan for the specified legal entity. The 401k integration must be activated before this endpoint can be called. The response includes the plan's unique identifier required for subsequent enrollment and management operations.7 params▾

Creates a new 401k plan for the specified legal entity. The 401k integration must be activated before this endpoint can be called. The response includes the plan's unique identifier required for subsequent enrollment and management operations.

NameTypeRequiredDescription

contribution_typestringrequiredType of contribution for the 401K plan.

legal_entity_idstringrequiredId from the legal entity to receive a new 401k plan

namestringrequiredName of the 401K plan.

start_datestringrequiredStart date of the plan.

contribution_valuenumberoptionalValue of the contribution if type is percent or amount.

contribution_value_for_match_ratearrayoptionalArray of objects containing limits and rates for match rate contribution type.

detailsobjectoptionalObject containing additional information about the 401K plan.

deelmcp_benefit_401k_plan_delete#Delete a 401k plan2 params▾

Delete a 401k plan

NameTypeRequiredDescription

idstringrequiredLegal entity id which plans belongs

plan_idstringrequiredPlan id

deelmcp_benefit_401k_plan_list#Returns all 401k plans configured for the specified legal entity.1 param▾

Returns all 401k plans configured for the specified legal entity.

NameTypeRequiredDescription

idstringrequiredId from the legal entity to fetch 401k plans

deelmcp_benefit_401k_plan_update#Replaces the full configuration of a 401k plan within the specified legal entity. As a PUT operation, the complete plan object must be supplied; any omitted fields will not be preserved.3 params▾

Replaces the full configuration of a 401k plan within the specified legal entity. As a PUT operation, the complete plan object must be supplied; any omitted fields will not be preserved.

NameTypeRequiredDescription

dataobjectrequiredSchema for the 401K Guideline Plan request body.

legal_entity_idstringrequiredId from the legal entity to update a 401k plan

plan_idstringrequired401K plan id

deelmcp_benefit_employee_get#Returns profile and contract data for a single employee within a legal entity integrated with an external benefits vendor. When `active_contracts` is `true`, only active contracts are included in the response.3 params▾

Returns profile and contract data for a single employee within a legal entity integrated with an external benefits vendor. When `active_contracts` is `true`, only active contracts are included in the response.

NameTypeRequiredDescription

employee_idstringrequiredEmployee id from the legal entity to fetch data

idstringrequiredId from the legal entity to fetch data

active_contractsbooleanoptionalFetch only active contracts for employees

deelmcp_benefit_employee_list#Returns employees belonging to the legal entity that has been integrated with an external benefits vendor. Results can be filtered to include only employees with active contracts.4 params▾

Returns employees belonging to the legal entity that has been integrated with an external benefits vendor. Results can be filtered to include only employees with active contracts.

NameTypeRequiredDescription

legal_entity_idstringrequiredId from the legal entity to fetch data

active_contractsbooleanoptionalFetch only active contracts for employees

items_per_pageintegeroptionalItems per page

offsetintegeroptionalItems to be skipped when searching

deelmcp_benefit_pay_stub_list#Get pay stub from employees from organization integrated with external benefits vendor6 params▾

Get pay stub from employees from organization integrated with external benefits vendor

NameTypeRequiredDescription

idstringrequiredId from the legal entity to fetch data

items_per_pageintegeroptionalItems per page

offsetintegeroptionalItems to be skipped when searching

payroll_end_datestringoptionalPayroll end date

payroll_start_datestringoptionalPayroll start date

statusstringoptionalPayroll status

deelmcp_benefit_payroll_setting_get#Get legal entity payroll settings from organization integrated with external benefits vendor1 param▾

Get legal entity payroll settings from organization integrated with external benefits vendor

NameTypeRequiredDescription

legal_entity_idstringrequiredId from the legal entity to fetch data

deelmcp_benefit_paystub_get#Get paystub by payroll event from legal entity integrated with external benefits vendor2 params▾

Get paystub by payroll event from legal entity integrated with external benefits vendor

NameTypeRequiredDescription

legal_entity_idstringrequiredLegal entity UUID

payroll_event_idstringrequiredPayroll id

deelmcp_benefit_paystub_list#Get paystubs from legal entity integrated with external benefits vendor6 params▾

Get paystubs from legal entity integrated with external benefits vendor

NameTypeRequiredDescription

legal_entity_idstringrequiredId from the legal entity to fetch data

cursorstringoptionalThe last fetched id to start querying from

date_endstringoptionalEnd date to fectch the paystubs

date_startstringoptionalStart date to fectch the paystubs from

items_per_pageintegeroptionalItems per page

statesarrayoptionalPayroll states: OPEN | LOCKED | CLOSED (OPEN doesn't have `employees` info)

deelmcp_benefits_ytd_pay_get#Returns aggregated year-to-date payroll figures for employees in the specified legal entity over a caller-specified date range. Both `date_start` and `date_end` are required.3 params▾

Returns aggregated year-to-date payroll figures for employees in the specified legal entity over a caller-specified date range. Both `date_start` and `date_end` are required.

NameTypeRequiredDescription

date_endstringrequiredEnd date to fetch aggregated pay data

date_startstringrequiredStart date to fetch aggregated pay data

idstringrequiredId from the legal entity to fetch data

deelmcp_clone_a_group#Clone an existing group within the organization. This creates a new group with the specified name, copying the structure and settings from the source group.2 params▾

Clone an existing group within the organization. This creates a new group with the specified name, copying the structure and settings from the source group.

NameTypeRequiredDescription

dataobjectrequiredNo description.

idstringrequiredUnique identifier of the group to be cloned.

deelmcp_compensation_band_bulk_update#Bulk-updates existing compensation bands. Each band is identified by ID or by the unique combination of job family group, job family, job profile, market, market group, and worker type. Accepts up to 1000 bands per request.1 param▾

Bulk-updates existing compensation bands. Each band is identified by ID or by the unique combination of job family group, job family, job profile, market, market group, and worker type. Accepts up to 1000 bands per request.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_compensation_band_create#Bulk creates or upserts up to 1000 compensation bands per request. Returns a summary of created and updated records. Bands define pay ranges for a job profile, market, and worker type combination.1 param▾

Bulk creates or upserts up to 1000 compensation bands per request. Returns a summary of created and updated records. Bands define pay ranges for a job profile, market, and worker type combination.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_compensation_band_delete#Permanently deletes a compensation band, nullifying any existing band point assignments. This action cannot be undone.1 param▾

Permanently deletes a compensation band, nullifying any existing band point assignments. This action cannot be undone.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the compensation band to delete.

deelmcp_compensation_band_get#Returns a single compensation band with all band point values and worker statistics. Optionally compare against a specific employee by providing their HRIS profile OID.2 params▾

Returns a single compensation band with all band point values and worker statistics. Optionally compare against a specific employee by providing their HRIS profile OID.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the compensation band to retrieve.

compareWithHrisProfileOidstringoptionalOptional HRIS profile OID to compare the band against a specific employee. When provided, workerStats will include the employee's band placement.

deelmcp_compensation_band_list#Returns a paginated list of compensation bands. Supports filtering by market, job profile, worker type, currency, status, and band IDs, as well as sorting by level or assigned worker count.12 params▾

Returns a paginated list of compensation bands. Supports filtering by market, job profile, worker type, currency, status, and band IDs, as well as sorting by level or assigned worker count.

NameTypeRequiredDescription

afterstringoptionalCursor for forward pagination — returns results after this cursor.

beforestringoptionalCursor for backward pagination — returns results before this cursor.

compensationBandIdsstringoptionalComma-separated list of compensation band IDs to filter by.

currenciesstringoptionalComma-separated list of currency codes to filter by.

jobProfilesstringoptionalComma-separated list of job profile IDs to filter by.

limitintegeroptionalNumber of results to return per page.

marketsstringoptionalComma-separated list of market IDs to filter by.

searchstringoptionalSearch term to filter by job profile name.

sortBystringoptionalField to sort results by.

sortOrderstringoptionalSort direction.

statusesstringoptionalComma-separated list of band statuses to filter by.

workerTypesstringoptionalComma-separated list of worker types to filter by.

deelmcp_compensation_band_point_update#Updates the band point configuration (indexes 1–9) for the organization. Points 1 and 9 must always be enabled. No separate GET exists — read current settings from the List Compensation Bands response.1 param▾

Updates the band point configuration (indexes 1–9) for the organization. Points 1 and 9 must always be enabled. No separate GET exists — read current settings from the List Compensation Bands response.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_compensation_band_update#Updates an existing compensation band. When `cashBandPointValues` is provided, it replaces the full band points list. Compensation bands define pay ranges for a job profile and market.2 params▾

Updates an existing compensation band. When `cashBandPointValues` is provided, it replaces the full band points list. Compensation bands define pay ranges for a job profile and market.

NameTypeRequiredDescription

dataobjectrequiredNo description.

idstringrequiredThe unique identifier of the compensation band to update.

deelmcp_compensation_job_family_create#Use this endpoint to create a new job family within an existing job family group. Job families group related job profiles under a common domain. Ensure you have the jobArchitecture.manage permission to perform this operation.1 param▾

Use this endpoint to create a new job family within an existing job family group. Job families group related job profiles under a common domain. Ensure you have the jobArchitecture.manage permission to perform this operation.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_compensation_job_family_group_create#Creates a new job family group — the top-level unit in the job architecture hierarchy used to group related job families.1 param▾

Creates a new job family group — the top-level unit in the job architecture hierarchy used to group related job families.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_compensation_job_family_group_list#Use this endpoint to retrieve a paginated list of job family groups for the organization. Supports filtering by name, IDs, and tracks, as well as sorting and pagination. Ensure you have the jobArchitecture.view permission to perform this operation.7 params▾

Use this endpoint to retrieve a paginated list of job family groups for the organization. Supports filtering by name, IDs, and tracks, as well as sorting and pagination. Ensure you have the jobArchitecture.view permission to perform this operation.

NameTypeRequiredDescription

jobFamilyGroupIdsarrayoptionalFilter by specific job family group IDs.

limitintegeroptionalMaximum number of results to return.

offsetintegeroptionalNumber of results to skip for pagination.

searchstringoptionalFilter job family groups by name.

sortBystringoptionalField to sort results by.

sortOrderstringoptionalSort direction.

tracksarrayoptionalFilter by job profile position tracks.

deelmcp_compensation_job_family_list#Returns a paginated list of job families. Supports filtering by name, job family group, IDs, and tracks, as well as sorting and pagination.8 params▾

Returns a paginated list of job families. Supports filtering by name, job family group, IDs, and tracks, as well as sorting and pagination.

NameTypeRequiredDescription

jobFamilyGroupIdsarrayoptionalFilter by parent job family group IDs.

jobFamilyIdsarrayoptionalFilter by specific job family IDs.

limitintegeroptionalMaximum number of results to return.

offsetintegeroptionalNumber of results to skip for pagination.

searchstringoptionalFilter job families by name.

sortBystringoptionalField to sort results by.

sortOrderstringoptionalSort direction.

tracksarrayoptionalFilter by position tracks.

deelmcp_compensation_job_profile_bulk_assign#Use this endpoint to bulk assign or unassign job profiles to workers' primary active employment. Pass null as jobProfileId to remove an existing assignment. Ensure you have the jobProfile.manage permission to perform this operation.1 param▾

Use this endpoint to bulk assign or unassign job profiles to workers' primary active employment. Pass null as jobProfileId to remove an existing assignment. Ensure you have the jobProfile.manage permission to perform this operation.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_compensation_job_profile_create#Use this endpoint to create a new job profile within a job family in the job architecture module. Job profiles define seniority levels and tracks for workers. Ensure you have the jobProfile.manage permission to perform this operation.1 param▾

Use this endpoint to create a new job profile within a job family in the job architecture module. Job profiles define seniority levels and tracks for workers. Ensure you have the jobProfile.manage permission to perform this operation.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_compensation_job_profile_history_list#Returns a cursor paginated list of workers and their assigned job profiles for the organization's primary active employments. Supports filtering by assignment status, job title, manager, and country.10 params▾

Returns a cursor paginated list of workers and their assigned job profiles for the organization's primary active employments. Supports filtering by assignment status, job title, manager, and country.

NameTypeRequiredDescription

afterstringoptionalCursor for forward pagination. Use the cursor value from the previous response.

beforestringoptionalCursor for backward pagination.

countriesarrayoptionalFilter by worker country codes.

jobTitlesarrayoptionalFilter by job title.

limitintegeroptionalMaximum number of results to return per page.

managerIdsarrayoptionalFilter by manager IDs.

querystringoptionalSearch query to filter workers by name.

sortBystringoptionalField to sort results by.

sortOrderstringoptionalSort direction.

typesarrayoptionalFilter workers by assignment status. ASSIGNED = has a job profile, UNASSIGNED = does not.

deelmcp_compensation_job_profile_list#Returns a paginated list of job profiles. Supports filtering by name, job family, job family group, IDs, and tracks, as well as sorting and pagination.9 params▾

Returns a paginated list of job profiles. Supports filtering by name, job family, job family group, IDs, and tracks, as well as sorting and pagination.

NameTypeRequiredDescription

jobFamilyGroupIdsarrayoptionalFilter by job family group IDs.

jobFamilyIdsarrayoptionalFilter by job family IDs.

jobProfileIdsarrayoptionalFilter by specific job profile IDs.

limitintegeroptionalMaximum number of results to return.

offsetintegeroptionalNumber of results to skip for pagination.

searchstringoptionalFilter job profiles by name or description.

sortBystringoptionalField to sort results by.

sortOrderstringoptionalSort direction.

tracksarrayoptionalFilter by position tracks.

deelmcp_compensation_market_bulk_assign#Assigns multiple workers to sub-markets in a single request. Each assignment maps a worker (by ID or email) to a sub-market. Workers can only belong to one sub-market; reassignment moves them automatically.1 param▾

Assigns multiple workers to sub-markets in a single request. Each assignment maps a worker (by ID or email) to a sub-market. Workers can only belong to one sub-market; reassignment moves them automatically.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_compensation_market_bulk_unassign#Removes multiple workers from their assigned sub-markets in a single request. After unassignment, workers lose their sub-market association and their compensation band assignment is invalidated.1 param▾

Removes multiple workers from their assigned sub-markets in a single request. After unassignment, workers lose their sub-market association and their compensation band assignment is invalidated.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_compensation_market_group_create#Bulk creates market groups and their sub-markets. Each group requires a name, currency code, and at least one sub-market with eligible worker types. Defines the market structure used for compensation bands.1 param▾

Bulk creates market groups and their sub-markets. Each group requires a name, currency code, and at least one sub-market with eligible worker types. Defines the market structure used for compensation bands.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_compensation_market_group_get#Retrieves a single market group by its unique identifier, including all associated sub-markets and their eligible worker types. Market groups define the currency and sub-market structure used in compensation bands.1 param▾

Retrieves a single market group by its unique identifier, including all associated sub-markets and their eligible worker types. Market groups define the currency and sub-market structure used in compensation bands.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the market group to retrieve.

deelmcp_compensation_market_group_list#Returns a cursor-paginated list of market groups and sub-markets for the organization. Each market group defines a currency and contains sub-markets with eligible worker types. Filterable by name, worker types, and currencies.6 params▾

Returns a cursor-paginated list of market groups and sub-markets for the organization. Each market group defines a currency and contains sub-markets with eligible worker types. Filterable by name, worker types, and currencies.

NameTypeRequiredDescription

afterstringoptionalCursor for forward pagination.

beforestringoptionalCursor for backward pagination.

currenciesstringoptionalComma-separated list of currency codes to filter by.

limitintegeroptionalNumber of results to return per page.

searchstringoptionalSearch term to filter by market group name.

workerTypesstringoptionalComma-separated list of worker types to filter by.

deelmcp_compensation_market_group_update#Updates a market group by ID. Can update name, currency code, description, and sub-markets list. When markets is provided it replaces the existing sub-markets list; omitted sub-markets are deleted.2 params▾

Updates a market group by ID. Can update name, currency code, description, and sub-markets list. When markets is provided it replaces the existing sub-markets list; omitted sub-markets are deleted.

NameTypeRequiredDescription

dataobjectrequiredNo description.

idstringrequiredThe unique identifier of the market group to update.

deelmcp_compensation_market_list#Returns a paginated list of sub-markets. Sub-markets belong to a market group and define which worker types are eligible for compensation bands in a given geographic or logical segment.3 params▾

Returns a paginated list of sub-markets. Sub-markets belong to a market group and define which worker types are eligible for compensation bands in a given geographic or logical segment.

NameTypeRequiredDescription

afterstringoptionalCursor for forward pagination.

beforestringoptionalCursor for backward pagination.

limitintegeroptionalNumber of results to return per page.

deelmcp_compensation_market_worker_list#Returns a cursor-paginated list of workers assigned to a specific sub-market, with band assignment status, band stats status, current salary, and manager info.7 params▾

Returns a cursor-paginated list of workers assigned to a specific sub-market, with band assignment status, band stats status, current salary, and manager info.

NameTypeRequiredDescription

market_idstringrequiredThe unique identifier of the sub-market whose workers to list.

afterstringoptionalCursor for forward pagination.

citiesstringoptionalComma-separated list of cities to filter by.

jobTitlesstringoptionalComma-separated list of job titles to filter by.

limitintegeroptionalNumber of results to return per page.

managersstringoptionalComma-separated list of manager IDs to filter by.

searchstringoptionalSearch term to filter by worker name.

deelmcp_compliance_document_send_confirm#Step 2 of 2: confirms and executes a pending send-document operation, assigning the custom document to the specified workers. Requires the execution_id returned by the preview step.1 param▾

Step 2 of 2: confirms and executes a pending send-document operation, assigning the custom document to the specified workers. Requires the execution_id returned by the preview step.

NameTypeRequiredDescription

execution_idstringrequiredThe execution ID returned by the send preview step.

deelmcp_contract_amendment_create#Submits an amendment to modify the details of an existing contract. If the contract is already signed or active, the amendment must be approved and re-signed before the changes take effect.2 params▾

Submits an amendment to modify the details of an existing contract. If the contract is already signed or active, the amendment must be approved and re-signed before the changes take effect.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

dataobjectrequiredYou can specify any combination of data points that need changing.

deelmcp_contract_amendment_list#Retrieves the paginated list of amendments associated with a given contract, with optional filtering by amendment status and sign status.5 params▾

Retrieves the paginated list of amendments associated with a given contract, with optional filtering by amendment status and sign status.

NameTypeRequiredDescription

contract_idstringrequiredUnique identifier of the contract

cursorstringoptionalCursor for pagination.

limitintegeroptionalMaximum number of work statements to return.

sign_statusesarrayoptionalFilter by work statement sign status.

statusesarrayoptionalFilter by work statement status.

deelmcp_contract_bulk_update_create#Use this endpoint to execute bulk contract updates asynchronously. Currently, only completion_date updates for IC contracts are supported.1 param▾

Use this endpoint to execute bulk contract updates asynchronously. Currently, only completion_date updates for IC contracts are supported.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_contract_bulk_update_get#Returns the current status and row-level failures for a bulk contract update execution.1 param▾

Returns the current status and row-level failures for a bulk contract update execution.

NameTypeRequiredDescription

execution_idstringrequiredBulk contract update execution public ID.

deelmcp_contract_copy_bulk_create#Create copies of a batch of contracts. Use this endpoint to duplicate contracts efficiently. Ensure the correct source contracts and overrides are specified for each copy.1 param▾

Create copies of a batch of contracts. Use this endpoint to duplicate contracts efficiently. Ensure the correct source contracts and overrides are specified for each copy.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_contract_cost_center_create#Assign cost centers to employment by contract id2 params▾

Assign cost centers to employment by contract id

NameTypeRequiredDescription

contract_idstringrequiredEmployment's contract ID

dataobjectrequiredNo description.

deelmcp_contract_create#Creates a new contractor contract and returns it with its assigned `id`. After creation, invite the contractor to sign via `POST /contracts/{contract_id}/invitations`.1 param▾

Creates a new contractor contract and returns it with its assigned `id`. After creation, invite the contractor to sign via `POST /contracts/{contract_id}/invitations`.

NameTypeRequiredDescription

datastringrequiredNo description.

deelmcp_contract_custom_field_delete#Clears the value of a custom field on the specified contract, identified by the custom field `id`.2 params▾

Clears the value of a custom field on the specified contract, identified by the custom field `id`.

NameTypeRequiredDescription

contract_idstringrequiredContract id.

idstringrequiredCustom field id.

deelmcp_contract_custom_field_get#Retrieves a single custom field definition from a contract by its `id`, returning the field's name, type, settings, placement, and description.1 param▾

Retrieves a single custom field definition from a contract by its `id`, returning the field's name, type, settings, placement, and description.

NameTypeRequiredDescription

idstringrequiredCustom field id.

deelmcp_contract_custom_field_list#Returns all custom fields associated with the specified contract.1 param▾

Returns all custom fields associated with the specified contract.

NameTypeRequiredDescription

contract_idstringrequiredContract Id

deelmcp_contract_custom_field_update#Creates or updates custom field values on the specified contract. This is a full replacement operation — any custom field values not included in the request body will be removed.2 params▾

Creates or updates custom field values on the specified contract. This is a full replacement operation — any custom field values not included in the request body will be removed.

NameTypeRequiredDescription

contract_idstringrequiredContract id.

dataobjectrequiredNo description.

deelmcp_contract_get#Retrieves the full record for a specific contract by `contract_id`, including status, compensation, worker details, and metadata. Pass `expand=cost_centers` as a query parameter to include cost center data in the response.2 params▾

Retrieves the full record for a specific contract by `contract_id`, including status, compensation, worker details, and metadata. Pass `expand=cost_centers` as a query parameter to include cost center data in the response.

NameTypeRequiredDescription

contract_idstringrequiredUnique identifier of the contract.

expandstringoptionalInclude cost centers in the response.

deelmcp_contract_i9_dismiss#Marks the I-9 for a given contract as verified outside of Deel1 param▾

Marks the I-9 for a given contract as verified outside of Deel

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the contract.

deelmcp_contract_invoice_adjustment_list#Retrieves invoice line items (adjustments) associated with a given contract_id, with support for filtering by contract type, adjustment type, status, invoice, reporter, and submission date range.10 params▾

Retrieves invoice line items (adjustments) associated with a given contract_id, with support for filtering by contract type, adjustment type, status, invoice, reporter, and submission date range.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

contract_typesarrayoptionalList of contract types

date_fromstringoptionalShort date in format ISO-8601 (YYYY-MM-DD). For example 2022-12-31.

date_tostringoptionalShort date in format ISO-8601 (YYYY-MM-DD). For example 2022-12-31.

invoice_idstringoptionalID of an existing invoice

limitstringoptionalReturn a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings

offsetstringoptionalReturn a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings

reporter_idstringoptionalID of an existing profile

statusesarrayoptionalstatuses of invoice adjustment to filter

typesarrayoptionaltypes of invoice adjustments to filter

deelmcp_contract_list#Returns a paginated list of contract summaries with optional filtering by status, type, team, country, currency, external ID, or name. Use `GET /contracts/{contract_id}` for full details.13 params▾

Returns a paginated list of contract summaries with optional filtering by status, type, team, country, currency, external ID, or name. Use `GET /contracts/{contract_id}` for full details.

NameTypeRequiredDescription

after_cursorstringoptionalReturn next page of results after the given cursor.

countriesarrayoptionalFilter contracts by country codes.

currenciesarrayoptionalFilter contracts by currency codes.

expandstringoptionalInclude cost centers in the response.

external_idstringoptionalFilter contracts for the given external ID.

external_id_absentstringoptionalFilter contracts by external ID presence. When true, returns contracts without an external ID. When false, returns contracts with an external ID. Cannot be used with external_id query param when set to true.

limitstringoptionalReturn a page of results with the given number of records.

order_directionstringoptionalOrder direction of results; ascending or descending.

searchstringoptionalInclude a contract if its name or the contractor's name contains the given search term.

sort_bystringoptionalSort contracts by the given field name.

statusesarrayoptionalFilter contracts by current status. A contract is included in the results if its status is in this list.

team_idstringoptionalFilter contracts for the given team ID. NOTE: All query parameters are technically strings or arrays of strings.

typesarrayoptionalFilter contracts by type. A contract is included in the results if its type is in this list.

deelmcp_contract_milestone_review_bulk_create#Review a batch of milestones to approve or reject submitted work.2 params▾

Review a batch of milestones to approve or reject submitted work.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

dataobjectrequiredNo description.

deelmcp_contract_milestone_review_create#Review a milestone to approve or decline submitted work.3 params▾

Review a milestone to approve or decline submitted work.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

dataobjectrequiredNo description.

milestone_idstringrequiredID of milestone to return

deelmcp_contract_off_cycle_payment_create#Creates a new invoice line item for an off-cycle payment against a specific contract, for use when a payment must be issued outside the regular payment schedule.2 params▾

Creates a new invoice line item for an off-cycle payment against a specific contract, for use when a payment must be issued outside the regular payment schedule.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier (ID) of the Deel contract for which the off-cycle payment is being created.

dataobjectoptionalNo description.

deelmcp_contract_off_cycle_payment_get#Retrieves a single off-cycle payment identified by id within a specific contract.2 params▾

Retrieves a single off-cycle payment identified by id within a specific contract.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

idstringrequiredDeel off-cycle payment id.

deelmcp_contract_off_cycle_payment_list#Retrieves all off-cycle payments for a specified contract. Off-cycle payments represent payments made outside the regular payment schedule, such as exceptional or one-time expenses.1 param▾

Retrieves all off-cycle payments for a specified contract. Off-cycle payments represent payments made outside the regular payment schedule, such as exceptional or one-time expenses.

NameTypeRequiredDescription

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

deelmcp_contract_payroll_adjustment_list#Retrieves all adjustments associated with a specific contract, optionally scoped to a date range.3 params▾

Retrieves all adjustments associated with a specific contract, optionally scoped to a date range.

NameTypeRequiredDescription

contract_idstringrequiredDeel adjustment id.

fromstringoptionalFilter adjustments by start date.

tostringoptionalFilter adjustments by end date.

deelmcp_contract_pdf_download#Returns a secure, time-limited URL for downloading the PDF version of the contract identified by contract_id. The URL is accessible only to the authenticated worker associated with that contract.1 param▾

Returns a secure, time-limited URL for downloading the PDF version of the contract identified by contract_id. The URL is accessible only to the authenticated worker associated with that contract.

NameTypeRequiredDescription

contract_idstringrequiredThe unique public identifier of the contract.

deelmcp_contract_preview#Returns the rendered HTML content of an IC or EOR contract agreement for a given contract_id. If no templateId is provided, the default or currently assigned template is used. Global Payroll contract types are not supported.2 params▾

Returns the rendered HTML content of an IC or EOR contract agreement for a given contract_id. If no templateId is provided, the default or currently assigned template is used. Global Payroll contract types are not supported.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

templateIdstringoptionalID of an existing contract template.

deelmcp_contract_reject#Rejects a contract identified by contract_id, provided it is currently in a pending, unsigned state. Contracts that have already been signed or previously rejected are not eligible for this operation.1 param▾

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

NameTypeRequiredDescription

contract_idstringrequiredThe unique public identifier of the contract to reject. This is the contract's public ID that can be used to identify the specific contract in the system.

deelmcp_contract_sign#Signs a contract on behalf of the client (employer), advancing it through the hiring workflow to a pending-contractor-signature state. Can also sign a pending amendment on an active contract.2 params▾

Signs a contract on behalf of the client (employer), advancing it through the hiring workflow to a pending-contractor-signature state. Can also sign a pending amendment on an active contract.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

dataobjectoptionalNo description.

deelmcp_contract_sign_invite_delete#Removes the active signing invitation from a contract to allow a new invitation to be issued to the worker.1 param▾

Removes the active signing invitation from a contract to allow a new invitation to be issued to the worker.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

deelmcp_contract_sign_invite_get#Retrieves the signing invitation link generated for the worker on a contract, with optional localization via the `locale` parameter.2 params▾

Retrieves the signing invitation link generated for the worker on a contract, with optional localization via the `locale` parameter.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

localestringoptionalCountry code in ISO Alpha-2 format (lowercase).

deelmcp_contract_sign_invite_send#Sends a signing invitation email to a worker, setting their email as the expected signer. Resets a previously rejected contract to signing-eligible. Cannot be called if the worker has already signed.2 params▾

Sends a signing invitation email to a worker, setting their email as the expected signer. Resets a previously rejected contract to signing-eligible. Cannot be called if the worker has already signed.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

dataobjectoptionalNo description.

deelmcp_contract_task_bulk_review#Approves or declines multiple submitted tasks associated with a contract in a single request. Each task review must include a status of approved or declined, with an optional reason required when declining.2 params▾

Approves or declines multiple submitted tasks associated with a contract in a single request. Each task review must include a status of approved or declined, with an optional reason required when declining.

NameTypeRequiredDescription

contract_idstringrequiredThe unique Deel contract ID associated with the tasks.

dataobjectoptionalNo description.

deelmcp_contract_task_create#Creates a new task for the contractor associated with the specified contract. A task can include an amount, description, and submission date.2 params▾

Creates a new task for the contractor associated with the specified contract. A task can include an amount, description, and submission date.

NameTypeRequiredDescription

contract_idstringrequiredThe unique Deel contract ID associated with the task.

dataobjectoptionalNo description.

deelmcp_contract_task_delete#Deletes a specific task from a contract. An optional `reason` can be supplied for audit or documentation purposes.3 params▾

Deletes a specific task from a contract. An optional `reason` can be supplied for audit or documentation purposes.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the Deel contract.

task_idstringrequiredThe unique identifier of the task to be deleted.

reasonstringoptionalThe reason for deleting the task. This can be used for auditing purposes.

deelmcp_contract_task_list#Retrieves all tasks associated with a specific contract, including each task's ID, amount, submission date, status, and description.1 param▾

Retrieves all tasks associated with a specific contract, including each task's ID, amount, submission date, status, and description.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier for the Deel contract.

deelmcp_contract_task_review#Submits an approval or rejection review for a task associated with a contract. If the review status is declined, an optional reason may be included in the request body.3 params▾

Submits an approval or rejection review for a task associated with a contract. If the review status is declined, an optional reason may be included in the request body.

NameTypeRequiredDescription

contract_idstringrequiredThe unique Deel contract ID associated with the task.

task_idstringrequiredThe unique ID of the task to be reviewed.

dataobjectoptionalNo description.

deelmcp_contract_template_list#Returns all contract templates available to the organization, including fixed-rate, pay-as-you-go, and milestone-based types. Template identifiers returned here can be supplied when creating new contracts.0 params▾

Returns all contract templates available to the organization, including fixed-rate, pay-as-you-go, and milestone-based types. Template identifiers returned here can be supplied when creating new contracts.

deelmcp_contract_termination_create#Initiates termination of an active contract, recording the termination reason, effective date, and any final payment details. Can only be called on contracts that are currently active.2 params▾

Initiates termination of an active contract, recording the termination reason, effective date, and any final payment details. Can only be called on contracts that are currently active.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the contractor contract

dataobjectrequiredTermination data. At minimum, you must provide either terminate_now: true (for immediate termination) OR completion_date (for scheduled termination).

deelmcp_contract_termination_delete#Cancels a pending termination request for the specified contract, reverting the contract to its pre-termination state. Only termination requests that have not yet reached their effective date can be cancelled.1 param▾

Cancels a pending termination request for the specified contract, reverting the contract to its pre-termination state. Only termination requests that have not yet reached their effective date can be cancelled.

NameTypeRequiredDescription

contract_idstringrequiredUnique identifier for the contract

deelmcp_contract_termination_reason_list#Retrieves the standardized list of termination reasons to present when initiating a contract termination4 params▾

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

NameTypeRequiredDescription

cursorstringoptionalCursor for pagination. Use the value from `next_cursor` in the previous response to fetch the next page.

limitintegeroptionalNumber of items to return per page (default: 20, max: 100)

orderstringoptionalSort direction for results

order_bystringoptionalField to order results by

deelmcp_contract_timesheet_list#Returns timesheets associated with the specified contract, with optional filtering by contract type, status, reporter, and date range.8 params▾

Returns timesheets associated with the specified contract, with optional filtering by contract type, status, reporter, and date range.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

contract_typesstringoptionalTypes of contracts to filter.

date_fromstringoptionalShort date in format ISO-8601 (YYYY-MM-DD). For example 2022-12-31.

date_tostringoptionalShort date in format ISO-8601 (YYYY-MM-DD). For example 2022-12-31.

limitstringoptionalReturn a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings

offsetstringoptionalReturn a page of results after given index of row

reporter_idstringoptionalID of an existing profile

statusesstringoptionalStatuses of timesheets to filter.

deelmcp_contract_update#Sets an external identifier to link internal reference IDs (e.g. employee numbers, ERP keys) to a Deel worker. Must be unique. Can be used as a filter when listing contracts.2 params▾

Sets an external identifier to link internal reference IDs (e.g. employee numbers, ERP keys) to a Deel worker. Must be unique. Can be used as a filter when listing contracts.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

dataobjectrequiredNo description.

deelmcp_delay_eor_employee_onboarding#Delay EOR employee onboarding2 params▾

Delay EOR employee onboarding

NameTypeRequiredDescription

dataobjectrequiredNo description.

oidstringrequiredContract oid

deelmcp_delete_worker_relation#Delete a worker relation.1 param▾

Delete a worker relation.

NameTypeRequiredDescription

hrisProfileOidstringrequiredWorker Relation ID

deelmcp_delete_worker_relation_external_id#Delete a worker relation by external id.1 param▾

Delete a worker relation by external id.

NameTypeRequiredDescription

profileIdstringrequiredWorker Relation external ID

deelmcp_delete_worker_relation_type_external_id#Delete a Worker Relation Type by the external ID.1 param▾

Delete a Worker Relation Type by the external ID.

NameTypeRequiredDescription

externalIdstringrequiredWorker Relation Type external ID

deelmcp_document_bulk_reminder_confirm#Send reminder notifications to workers with a pending document assignment1 param▾

Send reminder notifications to workers with a pending document assignment

NameTypeRequiredDescription

execution_idstringrequiredThe execution ID returned by the bulk-remind preview step.

deelmcp_document_bulk_reminder_preview#Previews a bulk reminder operation for a custom document. Returns recipient count, sample names, and an execution ID. Nothing is sent — must be followed by the confirm endpoint.6 params▾

Previews a bulk reminder operation for a custom document. Returns recipient count, sample names, and an execution ID. Nothing is sent — must be followed by the confirm endpoint.

NameTypeRequiredDescription

documentTemplateIdstringrequiredUnique identifier of the document template to send reminders for.

customMessagestringoptionalOptional custom message to include in the reminder.

documentStatusesarrayoptionalFilter recipients by document status.

hiringStatusesarrayoptionalFilter recipients by hiring status.

searchstringoptionalFilter recipients by worker name.

workerIdsarrayoptionalSpecific worker IDs to remind. If empty, all eligible workers are included.

deelmcp_document_bulk_reminder_result_get#Returns the full recipient list for a pending bulk reminder execution. Use after the preview step to show the user exactly who will be reminded about a custom document before they confirm.1 param▾

Returns the full recipient list for a pending bulk reminder execution. Use after the preview step to show the user exactly who will be reminded about a custom document before they confirm.

NameTypeRequiredDescription

execution_idstringrequiredThe execution ID returned by the bulk-remind preview step.

deelmcp_document_compliance_cancel#Cancels a custom document assignment for a specific worker. Only works on documents not yet completed or signed. Triggers onboarding reassessment.2 params▾

Cancels a custom document assignment for a specific worker. Only works on documents not yet completed or signed. Triggers onboarding reassessment.

NameTypeRequiredDescription

document_template_idstringrequiredUnique identifier of the document template.

workerIdstringrequiredUnique identifier of the worker whose document assignment is being cancelled.

deelmcp_document_compliance_download#Returns pre-signed download URLs (valid 15 minutes) for a submitted custom document. Returns an empty array if the document has not yet been submitted. Handles regular PDFs, e-signature documents, and uploaded files.2 params▾

Returns pre-signed download URLs (valid 15 minutes) for a submitted custom document. Returns an empty array if the document has not yet been submitted. Handles regular PDFs, e-signature documents, and uploaded files.

NameTypeRequiredDescription

document_template_idstringrequiredUnique identifier of the document template.

worker_idstringrequiredUnique identifier of the worker.

deelmcp_document_compliance_list#Search and filter custom document submissions across all workers for a given template. Use to answer "who has submitted/not submitted document X?".6 params▾

Search and filter custom document submissions across all workers for a given template. Use to answer "who has submitted/not submitted document X?".

NameTypeRequiredDescription

document_template_idstringrequiredThe ID of the document template to search within.

cursorstringoptionalPagination cursor from a previous response.

document_statusesarrayoptionalFilter by document status.

hiring_statusesarrayoptionalFilter by worker hiring status.

limitnumberoptionalMaximum number of results to return per page.

searchstringoptionalFilter by worker name.

deelmcp_document_compliance_remind#Sends a reminder email to specific workers about a pending custom document. Has a built-in 24-hour rate limit per worker — workers reminded within the last 24 hours are silently skipped.4 params▾

Sends a reminder email to specific workers about a pending custom document. Has a built-in 24-hour rate limit per worker — workers reminded within the last 24 hours are silently skipped.

NameTypeRequiredDescription

document_template_idstringrequiredUnique identifier of the document template.

workerIdsarrayrequiredList of worker IDs to send reminders to. Between 1 and 100.

customMessagestringoptionalOptional custom message to include in the reminder email.

titlestringoptionalOptional custom subject line for the reminder email.

deelmcp_document_send_preview#Step 1 of 2: previews sending a custom document to one or more workers. Returns recipient count, sample names, and an execution ID. Nothing is sent. Must be followed by the confirm endpoint.2 params▾

Step 1 of 2: previews sending a custom document to one or more workers. Returns recipient count, sample names, and an execution ID. Nothing is sent. Must be followed by the confirm endpoint.

NameTypeRequiredDescription

documentTemplateIdstringrequiredUnique identifier of the document template to send.

workerIdsarrayrequiredList of worker IDs to send the document to. At least 1 required.

deelmcp_document_template_list#Lists all custom document templates in the organization. Use when the user asks "what custom documents do we have?" or before sending a document to workers.7 params▾

Lists all custom document templates in the organization. Use when the user asks "what custom documents do we have?" or before sending a document to workers.

NameTypeRequiredDescription

cursorstringoptionalPagination cursor returned by a previous response.

document_typesarrayoptionalFilter by document action type.

limitintegeroptionalMaximum number of results to return per page.

mandatory_optionalarrayoptionalFilter by whether the document is required or optional.

searchstringoptionalFree-text search on document template name.

sort_bystringoptionalField to sort results by.

sort_orderstringoptionalSort direction.

deelmcp_draft_quote_create#Use this endpoint to create draft quotes for preparing contracts. This process helps in establishing preliminary terms before finalizing.1 param▾

Use this endpoint to create draft quotes for preparing contracts. This process helps in establishing preliminary terms before finalizing.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_draft_quote_update#Use this endpoint to update a draft quote before it becomes a contract.2 params▾

Use this endpoint to update a draft quote before it becomes a contract.

NameTypeRequiredDescription

dataobjectrequiredDraft quote fields to update. All fields are optional.

draft_quote_idstringrequiredUnique identifier of the draft quote to update.

deelmcp_engage_learning_journey_list#Returns cursor-paginated ActionableJourneys (Courses) assigned to the authenticated worker.4 params▾

Returns cursor-paginated ActionableJourneys (Courses) assigned to the authenticated worker.

NameTypeRequiredDescription

cursorstringoptionalCursor to the next page of results. If not provided, the first page will be returned.

journey_assignment_idsarrayoptionalFilter by JourneyAssignment IDs.

journey_idsarrayoptionalFilter by Journey IDs.

limitnumberoptionalReturn a page of results with given number of records.

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

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

NameTypeRequiredDescription

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

deelmcp_eor_amendment_accept#Accepts a pending amendment on an EOR worker contract, formally approving the proposed modifications on the client's behalf. The amendment must already exist and be in a pending state before this operation can be called.2 params▾

Accepts a pending amendment on an EOR worker contract, formally approving the proposed modifications on the client's behalf. The amendment must already exist and be in a pending state before this operation can be called.

NameTypeRequiredDescription

amendment_idstringrequiredA unique identifier for the employee contract amendment.

contract_idstringrequiredThe unique identifier of EOR worker contract.

deelmcp_eor_amendment_confirm#Confirms a draft amendment on an EOR contract and initiates the review process, routing it to Deel and the employee for acknowledgment and approval. The amendment must exist in a confirmable state prior to calling this endpoint.2 params▾

Confirms a draft amendment on an EOR contract and initiates the review process, routing it to Deel and the employee for acknowledgment and approval. The amendment must exist in a confirmable state prior to calling this endpoint.

NameTypeRequiredDescription

amendment_idstringrequiredA unique identifier for the employee contract amendment.

contract_idstringrequiredThe unique identifier of EOR worker contract.

deelmcp_eor_amendment_create#Creates a new amendment for an EOR contract, supporting changes to salary, currency, effective date, and other terms. Validated against applicable business and regulatory rules.2 params▾

Creates a new amendment for an EOR contract, supporting changes to salary, currency, effective date, and other terms. Validated against applicable business and regulatory rules.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the EOR worker contract

dataobjectoptionalNo description.

deelmcp_eor_amendment_delete#Cancels a pending EOR contract amendment, voiding the request and preventing it from being reviewed or applied to the contract.2 params▾

Cancels a pending EOR contract amendment, voiding the request and preventing it from being reviewed or applied to the contract.

NameTypeRequiredDescription

amendment_idstringrequiredA unique identifier for the employee contract amendment.

contract_idstringrequiredThe unique identifier of EOR worker contract.

deelmcp_eor_amendment_get#Retrieves a specific amendment for an EOR contract.2 params▾

Retrieves a specific amendment for an EOR contract.

NameTypeRequiredDescription

amendment_idstringrequiredA unique identifier for the employee contract amendment.

contract_idstringrequiredThe unique identifier of EOR worker contract.

deelmcp_eor_amendment_list#Retrieves all amendments associated with a given EOR contract, including each amendment's type, effective date, and current status, providing a full history of changes applied to the contract.1 param▾

Retrieves all amendments associated with a given EOR contract, including each amendment's type, effective date, and current status, providing a full history of changes applied to the contract.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of EOR worker contract.

deelmcp_eor_amendment_pdf_download#Generates a secure, time-limited download URL for the PDF of a specific EOR contract amendment. The returned URL is valid for 15 minutes from the time of generation.2 params▾

Generates a secure, time-limited download URL for the PDF of a specific EOR contract amendment. The returned URL is valid for 15 minutes from the time of generation.

NameTypeRequiredDescription

amendment_idstringrequiredA unique identifier for the employee contract amendment.

contract_idstringrequiredThe unique identifier of EOR worker contract.

deelmcp_eor_amendment_settings_get#Returns validation settings for amendment data points on an EOR contract, optionally scoped by employment state. Use to determine which fields are editable and what constraints apply.2 params▾

Returns validation settings for amendment data points on an EOR contract, optionally scoped by employment state. Use to determine which fields are editable and what constraints apply.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of EOR worker contract.

employment_statestringoptionalThe employment state of the EOR worker contract

deelmcp_eor_amendment_sign#Records the employee's signature on a specific contract amendment, confirming acceptance of the amendment terms. Returns the updated amendment record upon successful signing.2 params▾

Records the employee's signature on a specific contract amendment, confirming acceptance of the amendment terms. Returns the updated amendment record upon successful signing.

NameTypeRequiredDescription

amendment_idstringrequiredA unique identifier for the employee contract amendment.

contract_idstringrequiredThe unique identifier of EOR worker contract.

deelmcp_eor_amendment_update#Applies a partial update to a specific EOR contract amendment. The amendment must be in DRAFT status; updates to amendments in any other state will be rejected. This operation overwrites existing draft data and cannot be undone.3 params▾

Applies a partial update to a specific EOR contract amendment. The amendment must be in DRAFT status; updates to amendments in any other state will be rejected. This operation overwrites existing draft data and cannot be undone.

NameTypeRequiredDescription

amendment_idstringrequiredA 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.

contract_idstringrequiredThe unique identifier of EOR worker contract.

dataobjectoptionalNo description.

deelmcp_eor_amendment_validate#Validates amendment data points for a given contract against any external validation rules before an amendment is submitted. This call should be made prior to creating an amendment to confirm that the proposed data points are acceptable.2 params▾

Validates amendment data points for a given contract against any external validation rules before an amendment is submitted. This call should be made prior to creating an amendment to confirm that the proposed data points are acceptable.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

dataobjectoptionalDynamic object containing amendment fields. Supports flexible keys such as scope, job_title, or others.

deelmcp_eor_assignment_accept#Records client approval of a project assignment for an EOR contract, confirming that the terms have been reviewed and accepted.2 params▾

Records client approval of a project assignment for an EOR contract, confirming that the terms have been reviewed and accepted.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

dataobjectoptionalNo description.

deelmcp_eor_assignment_checkin_get#Returns the checkin questionnaire for a project assignment, including all sections and questions. The optional `version` parameter ensures the fetched questionnaire matches an expected version.2 params▾

Returns the checkin questionnaire for a project assignment, including all sections and questions. The optional `version` parameter ensures the fetched questionnaire matches an expected version.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the contract.

versionstringoptionalThis 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.

deelmcp_eor_assignment_checkin_submit#Submits completed answers for a project assignment checkin questionnaire. All required questionnaire fields must be included; partial submissions are not accepted.2 params▾

Submits completed answers for a project assignment checkin questionnaire. All required questionnaire fields must be included; partial submissions are not accepted.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the contract.

dataobjectoptionalForm submission payload containing respondent type, question answers, and optional version.

deelmcp_eor_assignment_get#Returns the project assignment PDF for an EOR contract pending client approval. The optional version parameter allows callers to confirm the retrieved document matches an expected version before proceeding with acceptance.2 params▾

Returns the project assignment PDF for an EOR contract pending client approval. The optional version parameter allows callers to confirm the retrieved document matches an expected version before proceeding with acceptance.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

versionstringoptionalThis 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.

deelmcp_eor_bank_account_create#Registers a bank account for an EOR employee. Returns the `id` of the newly created bank account record.1 param▾

Registers a bank account for an EOR employee. Returns the `id` of the newly created bank account record.

NameTypeRequiredDescription

dataarrayrequiredArray of key value properties of bank account

deelmcp_eor_bank_guide_get#Returns the bank account form guide for the specified `country` and `currency` combination, providing the field structure required to add a new bank account for an EOR employee.2 params▾

Returns the bank account form guide for the specified `country` and `currency` combination, providing the field structure required to add a new bank account for an EOR employee.

NameTypeRequiredDescription

countrystringrequiredCountry

currencystringrequiredCurrency

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

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

NameTypeRequiredDescription

country_codestringrequiredCountry code.

employment_typestringrequiredType of employment

legal_entity_idstringrequiredThe ID of the legal entity.

team_idstringrequiredThe ID of the team the worker belongs to.

work_hours_per_weeknumberrequiredWorking hours per week

work_visabooleanrequiredIndicates if work visa is required.

deelmcp_eor_compliance_document_acknowledge#Submits the worker's consent acknowledgement for a compliance document that requires it. This operation is required before documents marked as needing acknowledgement are considered complete.1 param▾

Submits the worker's consent acknowledgement for a compliance document that requires it. This operation is required before documents marked as needing acknowledgement are considered complete.

NameTypeRequiredDescription

document_idstringrequiredThe unique identifier of the compliance document.

deelmcp_eor_compliance_document_download#Returns a time-limited download URL for a submitted compliance document. The URL expires at the time indicated by `expires_at` in the response.1 param▾

Returns a time-limited download URL for a submitted compliance document. The URL expires at the time indicated by `expires_at` in the response.

NameTypeRequiredDescription

document_idstringrequiredUnique identifier for a compliance document in Deel.

deelmcp_eor_compliance_document_list#Returns the list of compliance documents associated with an EOR employee.0 params▾

Returns the list of compliance documents associated with an EOR employee.

deelmcp_eor_compliance_document_send#Uploads a compliance document file against the specified `document_id` for an EOR employee.1 param▾

Uploads a compliance document file against the specified `document_id` for an EOR employee.

NameTypeRequiredDescription

document_idstringrequiredUnique identifier for a compliance document in Deel.

deelmcp_eor_compliance_template_download#Returns a time-limited download URL for the compliance document template associated with the given `document_id`, only if a template exists for that document.1 param▾

Returns a time-limited download URL for the compliance document template associated with the given `document_id`, only if a template exists for that document.

NameTypeRequiredDescription

document_idstringrequiredUnique identifier for a compliance document in Deel.

deelmcp_eor_contract_benefit_list#Returns benefits associated with the specified EOR contract.1 param▾

Returns benefits associated with the specified EOR contract.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the EOR contract.

deelmcp_eor_contract_cancel#Cancels the EOR contract identified by oid. The contract must be in an active or pending state to be eligible for cancellation.2 params▾

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

NameTypeRequiredDescription

dataobjectrequiredNo description.

oidstringrequiredContract oid

deelmcp_eor_contract_document_get#Returns a specific document as a PDF for a given EOR contract. Currently only the `FRAMEWORK_AGREEMENT` document type is supported.2 params▾

Returns a specific document as a PDF for a given EOR contract. Currently only the `FRAMEWORK_AGREEMENT` document type is supported.

NameTypeRequiredDescription

contract_idstringrequiredEOR contract ID

typestringrequiredThe type of document. Currently only FRAMEWORK_AGREEMENT is supported.

deelmcp_eor_contract_document_list#Returns all documents associated with a specific EOR contract.1 param▾

Returns all documents associated with a specific EOR contract.

NameTypeRequiredDescription

contract_idstringrequiredEOR contract ID

deelmcp_eor_contract_document_sign#Applies a signature and job title to a specified EOR contract document. Currently only the `FRAMEWORK_AGREEMENT` document type is supported.3 params▾

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

NameTypeRequiredDescription

contract_idstringrequiredEOR contract ID

typestringrequiredThe type of document. Currently only FRAMEWORK_AGREEMENT is supported.

dataobjectoptionalNo description.

deelmcp_eor_contract_form_get#Retrieves the versioned form definition for creating an EOR contract in the specified country, including fields, validation rules, and conditional logic. The `state` parameter is only required for countries that mandate it.5 params▾

Retrieves the versioned form definition for creating an EOR contract in the specified country, including fields, validation rules, and conditional logic. The `state` parameter is only required for countries that mandate it.

NameTypeRequiredDescription

country_codestringrequiredTwo-letter country code in ISO 3166-1 alpha-2 format

contract_duration_in_daysintegeroptionalThe contract duration in days for definite contracts.

start_datestringoptionalThe selected start date of the contract in ISO 8601 formatted date string.

statestringoptionalThe selected state code of the contract. This is only required for countries that specify it.

work_hours_per_weekintegeroptionalThe selected number of work hours per week.

deelmcp_eor_contract_forms_definition_get#Returns paginated, versioned form definitions for creating EOR contracts across specified countries. Use the latest effective version. Not for reading or updating existing contracts.3 params▾

Returns paginated, versioned form definitions for creating EOR contracts across specified countries. Use the latest effective version. Not for reading or updating existing contracts.

NameTypeRequiredDescription

dataobjectrequiredNo description.

cursorstringoptionalPagination cursor for fetching subsequent pages of results.

limitintegeroptionalMaximum number of countries to return in a single response. Defaults to 10.

deelmcp_eor_contract_get#Returns basic contract information and associated employment costs for a specific EOR contract.1 param▾

Returns basic contract information and associated employment costs for a specific EOR contract.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier for the Deel contract

deelmcp_eor_contract_offboarding_get#Retrieves the offboarding request associated with a specific EOR contract, including termination details, document review status, offboarding request data, and pending employee notification state.1 param▾

Retrieves the offboarding request associated with a specific EOR contract, including termination details, document review status, offboarding request data, and pending employee notification state.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

deelmcp_eor_contract_sign#Signs a contract on behalf of the contractor, transitioning contract status to active and completing the contractor onboarding workflow.2 params▾

Signs a contract on behalf of the contractor, transitioning contract status to active and completing the contractor onboarding workflow.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

dataobjectoptionalNo description.

deelmcp_eor_contract_update#Applies partial updates to mutable fields of an EOR contract, such as salary, job title, or benefits. Only fields included in the request body are modified; fields required for validation must still be present.2 params▾

Applies partial updates to mutable fields of an EOR contract, such as salary, job title, or benefits. Only fields included in the request body are modified; fields required for validation must still be present.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

dataobjectrequiredNo description.

deelmcp_eor_effective_date_limit_get#Returns validation rules for the effective date field within an EOR contract amendment flow.2 params▾

Returns validation rules for the effective date field within an EOR contract amendment flow.

NameTypeRequiredDescription

amendment_idstringrequiredA unique identifier for the employee contract amendment

contract_idstringrequiredThe unique identifier of the EOR worker contract

deelmcp_eor_employment_cost_batch#Determine the total employment costs for an Employee of Record (EOR) arrangement across different countries, including salary, employer costs, benefits, and additional fees.1 param▾

Determine the total employment costs for an Employee of Record (EOR) arrangement across different countries, including salary, employer costs, benefits, and additional fees.

NameTypeRequiredDescription

dataarrayrequiredArray of employee cost calculation requests.

deelmcp_eor_employment_cost_calculate#Calculates the total employment cost for an EOR arrangement in a specified country, returning a breakdown that includes employer costs, benefits, platform fees, and severance accrual.1 param▾

Calculates the total employment cost for an EOR arrangement in a specified country, returning a breakdown that includes employer costs, benefits, platform fees, and severance accrual.

NameTypeRequiredDescription

dataobjectoptionalNo description.

deelmcp_eor_hr_document_list#Returns all HR verification letters and documents associated with the employee contract.1 param▾

Returns all HR verification letters and documents associated with the employee contract.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

deelmcp_eor_hrx_document_get#Generates a pre-signed URL for downloading a specific HRX document as a PDF associated with an EOR contract. The URL expires 15 minutes after generation.2 params▾

Generates a pre-signed URL for downloading a specific HRX document as a PDF associated with an EOR contract. The URL expires 15 minutes after generation.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

document_idstringrequiredThe unique identifier of the document to download.

deelmcp_eor_hrx_document_list#Returns a paginated list of HRX documents shared with an employee under a specific EOR contract.3 params▾

Returns a paginated list of HRX documents shared with an employee under a specific EOR contract.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

cursorstringoptionalCursor for pagination. Use the cursor from the previous response to get the next page of results.

limitintegeroptionalNumber of items to return per page. Maximum is 100, default is 20.

deelmcp_eor_job_scope_list#Returns predefined and custom job scope templates available for EOR contracts, optionally filtered to templates belonging to a specific team.1 param▾

Returns predefined and custom job scope templates available for EOR contracts, optionally filtered to templates belonging to a specific team.

NameTypeRequiredDescription

teamstringoptionalTeam public id

deelmcp_eor_job_scope_validate#Validates a job scope description and returns any validation errors. When errors are present, the response also includes a `quote_validation_log_public_id` and pre-populated `data_for_corrected_job_scope_endpoint` to support subsequent correction.1 param▾

Validates a job scope description and returns any validation errors. When errors are present, the response also includes a `quote_validation_log_public_id` and pre-populated `data_for_corrected_job_scope_endpoint` to support subsequent correction.

NameTypeRequiredDescription

dataobjectrequireddetails of job scope

deelmcp_eor_mailbox_password_update#Changes the mailbox password for an EOR worker.1 param▾

Changes the mailbox password for an EOR worker.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_eor_offboarding_attachment_get#Downloads the content of a specific attachment associated with the termination for a given contract.2 params▾

Downloads the content of a specific attachment associated with the termination for a given contract.

NameTypeRequiredDescription

attachment_idstringrequiredThe unique identifier of the attachment to download.

contract_idstringrequiredThe unique identifier of the employee contract.

deelmcp_eor_offboarding_client_sign_off_review#Submits a client sign-off decision—approval or change request—for the offboarding documents of a specific contract during the client sign-off step.2 params▾

Submits a client sign-off decision—approval or change request—for the offboarding documents of a specific contract during the client sign-off step.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

dataobjectrequiredNo description.

deelmcp_eor_offboarding_create#Formally initiates the resignation process for the EOR contract by submitting a resignation request on behalf of the worker.1 param▾

Formally initiates the resignation process for the EOR contract by submitting a resignation request on behalf of the worker.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

deelmcp_eor_offboarding_employee_sign_off_review#Records an employee's sign-off decision—approval or change request with feedback—for the offboarding document set of a contract.2 params▾

Records an employee's sign-off decision—approval or change request with feedback—for the offboarding document set of a contract.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

dataobjectoptionalNo description.

deelmcp_eor_offboarding_pto_review_submit#Submits PTO details for a resignation request, triggers related notifications, and finalizes the PTO review step. Only callable when the resignation status is `AWAITING_PTO`.2 params▾

Submits PTO details for a resignation request, triggers related notifications, and finalizes the PTO review step. Only callable when the resignation status is `AWAITING_PTO`.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

dataobjectoptionalNo description.

deelmcp_eor_offboarding_required_info_get#Returns country-specific mandatory and optional questions, and identifies required supporting documents, that must be provided when initiating the offboarding process for a contract.1 param▾

Returns country-specific mandatory and optional questions, and identifies required supporting documents, that must be provided when initiating the offboarding process for a contract.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

deelmcp_eor_offboarding_restricted_date_list#Returns country-specific dates unavailable for offboarding end-date selection—including weekends and public holidays—along with the earliest available end date; optionally filtered by termination type.2 params▾

Returns country-specific dates unavailable for offboarding end-date selection—including weekends and public holidays—along with the earliest available end date; optionally filtered by termination type.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

termination_typestringoptionalType of offboarding.

deelmcp_eor_offboarding_timeoff_data_get#Returns time-off entitlements, balances, and upcoming time offs for the employee, optionally scoped to a target `end_date`. Includes policy settings required to complete an offboarding request.2 params▾

Returns time-off entitlements, balances, and upcoming time offs for the employee, optionally scoped to a target `end_date`. Includes policy settings required to complete an offboarding request.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

end_datestringoptionalDesired end date for offboarding

deelmcp_eor_payroll_agreement_download#Returns a time-limited download URL for the employee agreement PDF associated with the given `contract_id`. When the optional `version` parameter is supplied and a version mismatch is detected, behaviour diverges from the default resolution path.2 params▾

Returns a time-limited download URL for the employee agreement PDF associated with the given `contract_id`. When the optional `version` parameter is supplied and a version mismatch is detected, behaviour diverges from the default resolution path.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

versionstringoptionalOptional version of the Employment Agreement to be signed. If informed and in the case of a mismatch, the API will return an error.

deelmcp_eor_payslip_download#Returns a URL for downloading the specified payslip as a PDF.2 params▾

Returns a URL for downloading the specified payslip as a PDF.

NameTypeRequiredDescription

payslip_idstringrequiredUnique identifier for the payslip.

worker_idstringrequiredUnique identifier for the worker.

deelmcp_eor_payslip_list#Returns a list of payslip records for the specified worker.1 param▾

Returns a list of payslip records for the specified worker.

NameTypeRequiredDescription

worker_idstringrequiredThe ID of the worker whose payslips are being retrieved.

deelmcp_eor_resignation_create#Initiates a resignation request for an EOR contract.1 param▾

Initiates a resignation request for an EOR contract.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

deelmcp_eor_resignation_letter_get#Returns a preview of the resignation letter for the EOR contract before the worker submits their signature.1 param▾

Returns a preview of the resignation letter for the EOR contract before the worker submits their signature.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

deelmcp_eor_resignation_letter_sign#Records the worker's signature on the resignation letter for the contract, which is required to finalize the resignation process; upon successful submission, the signed letter is queued for PDF generation and further processing.2 params▾

Records the worker's signature on the resignation letter for the contract, which is required to finalize the resignation process; upon successful submission, the signed letter is queued for PDF generation and further processing.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

dataobjectrequiredNo description.

deelmcp_eor_resignation_list#Returns resignations submitted by EOR workers, optionally filtered by resignation letter status.1 param▾

Returns resignations submitted by EOR workers, optionally filtered by resignation letter status.

NameTypeRequiredDescription

statusstringoptionalFilter by resignation letter status

deelmcp_eor_resignation_request#Enable clients with group admin and people manager permissions to initiate a resignation request for an Employee of Record (EOR) contract within their team.2 params▾

Enable clients with group admin and people manager permissions to initiate a resignation request for an Employee of Record (EOR) contract within their team.

NameTypeRequiredDescription

dataobjectrequiredNo description.

oidstringrequiredPublic contract oid

deelmcp_eor_start_date_get#Returns the earliest allowed start date for a new EOR contract based on employment country, nationality, and visa requirements. Also returns payroll timing parameters that govern when the contract can take effect.7 params▾

Returns the earliest allowed start date for a new EOR contract based on employment country, nationality, and visa requirements. Also returns payroll timing parameters that govern when the contract can take effect.

NameTypeRequiredDescription

employment_countrystringrequiredEmployment country in ISO 3166-1 alpha-2 format

team_idstringrequiredTeam ID

employee_nationalitystringoptionalEmployee nationality in ISO 3166-1 alpha-2 format

employment_statestringoptionalState or province of employment

legal_entity_idstringoptionalLegal entity ID

special_job_idstringoptionalSpecial job ID (if applicable)

work_visabooleanoptionalWhether a work visa is required

deelmcp_eor_tax_document_list#Returns tax documents for the authenticated worker.0 params▾

Returns tax documents for the authenticated worker.

deelmcp_eor_termination_create#Initiates a termination request for an EOR contract, beginning the offboarding process. Returns desired and confirmed end dates along with any termination documents generated.1 param▾

Initiates a termination request for an EOR contract, beginning the offboarding process. Returns desired and confirmed end dates along with any termination documents generated.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

deelmcp_eor_termination_request#This API enables clients with group admin and people manager permissions to initiate a request for the termination of an Employee of Record (EOR) contract for members of their team.2 params▾

This API enables clients with group admin and people manager permissions to initiate a request for the termination of an Employee of Record (EOR) contract for members of their team.

NameTypeRequiredDescription

dataobjectrequiredNo description.

oidstringrequiredPublic contract id

deelmcp_eor_validation_get#Returns country-specific hiring guide data — including salary requirements, holidays, probation terms, health insurance, and currency — for use in creating and validating EOR contract quotes.1 param▾

Returns country-specific hiring guide data — including salary requirements, holidays, probation terms, health insurance, and currency — for use in creating and validating EOR contract quotes.

NameTypeRequiredDescription

country_codestringrequiredCountry code in ISO Alpha-2 format.

deelmcp_eor_worker_additional_info_add#Adds supplemental information fields to an EOR employee's contract record.2 params▾

Adds supplemental information fields to an EOR employee's contract record.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

dataobjectrequiredAdditional fields are country/state-specific and validated against the worker additional fields form for the employment country.

deelmcp_eor_worker_additional_info_update#Partially updates additional information on an EOR employee agreement. Only permitted when status is `new`, `under_review`, or `waiting_for_employee_contract`; other statuses return an error.2 params▾

Partially updates additional information on an EOR employee agreement. Only permitted when status is `new`, `under_review`, or `waiting_for_employee_contract`; other statuses return an error.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

dataobjectrequiredYou can submit any subset of fields. Keys not listed above are treated as country/state-specific additional information fields. Those keys must match the fields returned by GET /forms/eor/worker-additional-fields/{country_code} (public keys).

deelmcp_eor_worker_benefit_list#Returns the benefits for the authenticated employee. The employee identity is inferred from the auth token, so this endpoint must be called with an employee-scoped token rather than a client token.0 params▾

Returns the benefits for the authenticated employee. The employee identity is inferred from the auth token, so this endpoint must be called with an employee-scoped token rather than a client token.

deelmcp_eor_worker_create#Submits details for an Employee of Record (EOR) contract and returns a quote. Deel processes the submitted information and returns pricing, compensation, and health plan details before the contract is activated.1 param▾

Submits details for an Employee of Record (EOR) contract and returns a quote. Deel processes the submitted information and returns pricing, compensation, and health plan details before the contract is activated.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_eor_worker_info_update#Partially updates employee information on an EOR contract. Only documented fields are accepted. Restricted to contracts in pre-signature or review statuses; other statuses return a validation error.2 params▾

Partially updates employee information on an EOR contract. Only documented fields are accepted. Restricted to contracts in pre-signature or review statuses; other statuses return a validation error.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the employee contract.

dataobjectoptionalNo description.

deelmcp_eor_worker_profile_create#Creates an EOR worker record and returns the associated `user_id`, `profile_id`, and `hris_profile_id`.1 param▾

Creates an EOR worker record and returns the associated `user_id`, `profile_id`, and `hris_profile_id`.

NameTypeRequiredDescription

dataobjectoptionalNo description.

deelmcp_external_org_personal_info_update#Partially updates a worker's personal information using an external identifier. Only fields included in the request body are modified.2 params▾

Partially updates a worker's personal information using an external identifier. Only fields included in the request body are modified.

NameTypeRequiredDescription

dataobjectrequiredNo description.

worker_idstringrequiredUnique identifier for a worker (External ID).

deelmcp_external_org_worker_relation_create#Creates a hierarchical worker relation between a worker and their subordinates, using external IDs to identify all parties. The request body must supply the external IDs of both the parent and child workers along with the relation type.1 param▾

Creates a hierarchical worker relation between a worker and their subordinates, using external IDs to identify all parties. The request body must supply the external IDs of both the parent and child workers along with the relation type.

NameTypeRequiredDescription

dataobjectoptionalNo description.

deelmcp_external_org_worker_relation_list#Returns all worker relations associated with the HrisProfile identified by the given external ID, including both parent and child relationships.1 param▾

Returns all worker relations associated with the HrisProfile identified by the given external ID, including both parent and child relationships.

NameTypeRequiredDescription

profile_idstringrequiredHrisProfile external ID

deelmcp_external_org_worker_relation_update#Creates or replaces the parent worker relation for the HrisProfile identified by the given external ID. If a parent relation already exists for this profile, it is overwritten with the supplied data.2 params▾

Creates or replaces the parent worker relation for the HrisProfile identified by the given external ID. If a parent relation already exists for this profile, it is overwritten with the supplied data.

NameTypeRequiredDescription

profile_idstringrequiredHrisProfile external ID

dataobjectoptionalThe request payload containing parent relationship details.

deelmcp_forms_eor_worker_field_list#Retrieves the additional form fields required when onboarding EOR workers in the specified country.1 param▾

Retrieves the additional form fields required when onboarding EOR workers in the specified country.

NameTypeRequiredDescription

country_codestringrequiredCountry code

deelmcp_forms_gp_worker_field_list#Retrieves the country-specific additional information fields required for GP workers to run payroll in compliance with local regulations.1 param▾

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

NameTypeRequiredDescription

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

deelmcp_get_all_profile_worker_relations#List of worker relations.1 param▾

List of worker relations.

NameTypeRequiredDescription

hrisProfileOidstringrequiredHrisProfile ID

deelmcp_get_eor_bank_account_guide#Retrieve bank account form guide for an EOR employee. This data can be used to add a new bank account for an employee.0 params▾

Retrieve bank account form guide for an EOR employee. This data can be used to add a new bank account for an employee.

deelmcp_get_eor_termination#This API allows clients and employees with viewer permissions to retrieve termination data. It ensures that only authorized users can access sensitive information related to terminations.2 params▾

This API allows clients and employees with viewer permissions to retrieve termination data. It ensures that only authorized users can access sensitive information related to terminations.

NameTypeRequiredDescription

oidstringrequiredPublic contract oid

terminationIdstringrequiredTermination id

deelmcp_gp_bank_account_create#Adds a bank account for the GP worker; country-specific field requirements must be retrieved from `GET /gp/workers/{worker_id}/banks/guide` before submitting.2 params▾

Adds a bank account for the GP worker; country-specific field requirements must be retrieved from `GET /gp/workers/{worker_id}/banks/guide` before submitting.

NameTypeRequiredDescription

dataobjectrequiredNo description.

worker_idstringrequiredUnique identifier for a worker in UUID format.

deelmcp_gp_bank_account_list#Returns all bank accounts associated with the employee.1 param▾

Returns all bank accounts associated with the employee.

NameTypeRequiredDescription

worker_idstringrequiredUnique identifier for a worker.

deelmcp_gp_bank_account_update#Partially updates the bank account for the worker; only fields provided in the request body are modified.25 params▾

Partially updates the bank account for the worker; only fields provided in the request body are modified.

NameTypeRequiredDescription

bank_idstringrequiredUnique identifier for the bank account in UUID format.

worker_idstringrequiredUnique identifier for a worker in UUID format.

account_numberstringoptionalThe user's bank account number.

account_typestringoptionalBank account type.

ach_routing_numberstringoptionalThe ACH (Automated Clearing House) Routing Number.

address_line1stringoptionalThe primary address line.

address_line2stringoptionalThe secondary address line.

bank_branch_namestringoptionalThe name of the user's bank branch.

bank_codestringoptionalThe bank code.

bank_country_codestringoptionalThe country code where the bank is located.

bank_namestringoptionalName of the user's bank.

branch_codestringoptionalThe branch code of the user's bank.

citystringoptionalThe city of the user's address.

country_codestringoptionalThe country code of the user's address.

currency_codestringoptionalThe currency code for transactions.

emailstringoptionalThe user's email address.

full_namestringoptionalFull name of the user.

ibanstringoptionalThe International Bank Account Number (IBAN).

original_namestringoptionalThe original name of the user.

phonestringoptionalThe user's phone number.

postalstringoptionalThe user's postal or ZIP code.

province_statestringoptionalThe state or province of the user's address.

rib_numberstringoptionalThe RIB (Relevé d'Identité Bancaire).

swift_bicstringoptionalSWIFT/BIC code for the bank.

tax_idstringoptionalThe user's tax identification number.

deelmcp_gp_bank_guide_get#Returns the country-specific field requirements for a worker's bank account form, which determines the fields required when adding a bank account.1 param▾

Returns the country-specific field requirements for a worker's bank account form, which determines the fields required when adding a bank account.

NameTypeRequiredDescription

worker_idstringrequiredUnique identifier for a worker in UUID format.

deelmcp_gp_contract_job_title_update#Use this API to update the job title for a contract. Provide the contract ID and new job title details to make a change.2 params▾

Use this API to update the job title for a contract. Provide the contract ID and new job title details to make a change.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the GP contract.

dataobjectrequiredNo description.

deelmcp_gp_gtn_report_download#Downloads the gross-to-net calculation report for the specified payroll report as a CSV file, with optional currency conversion applied.2 params▾

Downloads the gross-to-net calculation report for the specified payroll report as a CSV file, with optional currency conversion applied.

NameTypeRequiredDescription

idstringrequiredId of the gp payroll report.

currencystringoptionalCurrency to be used in the report calculation.

deelmcp_gp_gtn_report_get#Returns paginated gross-to-net calculation records for the specified payroll report, with optional currency conversion applied to the results.4 params▾

Returns paginated gross-to-net calculation records for the specified payroll report, with optional currency conversion applied to the results.

NameTypeRequiredDescription

idstringrequiredId of the gp payroll report.

currencystringoptionalCurrency to be used in the report calculation.

limitnumberoptionalMaximum number of records to return.

offsetnumberoptionalOffset/index of record for the next page of records to return.

deelmcp_gp_payroll_report_list#Retrieves payroll events associated with the specified legal entity, suitable for preparing payroll reports or auditing pay cycles.1 param▾

Retrieves payroll events associated with the specified legal entity, suitable for preparing payroll reports or auditing pay cycles.

NameTypeRequiredDescription

legal_entity_idstringrequiredUnique identifier for the legal entity in UUID format.

deelmcp_gp_payslip_download#Returns a pre-signed, temporary download URL for a GP employee payslip PDF. Use after calling the payslips list endpoint to obtain the `payslip_id`. Supports only GP contract types.2 params▾

Returns a pre-signed, temporary download URL for a GP employee payslip PDF. Use after calling the payslips list endpoint to obtain the `payslip_id`. Supports only GP contract types.

NameTypeRequiredDescription

idstringrequiredUnique identifier for the worker in UUID format.

payslipIdstringrequiredUnique identifier for the payslip in UUID format.

deelmcp_gp_payslip_list#Returns the payslip history for a GP employee, including each payslip's date range and status. Restricted to GP contract types. Each payslip in the response includes an `id` required by the payslip download endpoint.1 param▾

Returns the payslip history for a GP employee, including each payslip's date range and status. Restricted to GP contract types. Each payslip in the response includes an `id` required by the payslip download endpoint.

NameTypeRequiredDescription

idstringrequiredUnique identifier for the worker in UUID format.

deelmcp_gp_termination_create#Initiates the termination process for a Global Payroll worker. A successful response confirms the request was accepted and the process has begun, but does not indicate that termination is complete.2 params▾

Initiates the termination process for a Global Payroll worker. A successful response confirms the request was accepted and the process has begun, but does not indicate that termination is complete.

NameTypeRequiredDescription

dataobjectrequiredNo description.

worker_idstringrequiredUnique identifier for a worker in UUID format.

deelmcp_gp_worker_additional_info_update#Partially updates the additional information on the contract; only fields supplied under the `data` object are modified.2 params▾

Partially updates the additional information on the contract; only fields supplied under the `data` object are modified.

NameTypeRequiredDescription

contract_idstringrequiredThe unique public identifier of the contract.

dataobjectrequiredNo description.

deelmcp_gp_worker_address_update#Partially updates the address on record for the GP employee.2 params▾

Partially updates the address on record for the GP employee.

NameTypeRequiredDescription

dataobjectrequiredNo description.

worker_idstringrequiredUnique identifier for a worker in UUID format.

deelmcp_gp_worker_compensation_update#Updates the compensation for the GP employee and returns the complete compensation history including the applied change.2 params▾

Updates the compensation for the GP employee and returns the complete compensation history including the applied change.

NameTypeRequiredDescription

dataobjectrequiredNo description.

worker_idstringrequiredUnique identifier for a worker in UUID format.

deelmcp_gp_worker_employee_info_update#Partially updates personal details, tax information, and employment-related fields for the GP worker.2 params▾

Partially updates personal details, tax information, and employment-related fields for the GP worker.

NameTypeRequiredDescription

dataobjectrequiredNo description.

worker_idstringrequiredUnique identifier for a worker in UUID format.

deelmcp_gp_worker_info_add#Adds supplementary fields to the contract, with the extra data supplied under the `data` object in the request body.2 params▾

Adds supplementary fields to the contract, with the extra data supplied under the `data` object in the request body.

NameTypeRequiredDescription

contract_idstringrequiredThe unique public identifier of the contract.

dataobjectrequiredNo description.

deelmcp_gp_worker_pto_update#Applies a partial update to the PTO policy assigned to a Global Payroll worker. Only fields included in the request body are modified; omitted fields retain their current values.2 params▾

Applies a partial update to the PTO policy assigned to a Global Payroll worker. Only fields included in the request body are modified; omitted fields retain their current values.

NameTypeRequiredDescription

dataobjectrequiredNo description.

worker_idstringrequiredUnique identifier for a worker in UUID format.

deelmcp_hiring_insights_employment_comparison_list#Use this endpoint to compare employment regulations, costs, time off, and payroll details across one or more countries for hiring analysis.6 params▾

Use this endpoint to compare employment regulations, costs, time off, and payroll details across one or more countries for hiring analysis.

NameTypeRequiredDescription

categoriesarrayoptionalComparison categories to include

countriesarrayoptionalCountry codes to compare (ISO 3166-1 alpha-2)

currencystringoptionalTarget currency (ISO 4217); when provided, amounts inside text are converted

cursorstringoptionalCursor for pagination to fetch the next page of results

draftstringoptionalDraft version of the data

limitnumberoptionalMaximum number of results to return

deelmcp_hiring_insights_eor_cost_calculate#Use this endpoint to compare EOR and local entity options for international hiring.1 param▾

Use this endpoint to compare EOR and local entity options for international hiring.

NameTypeRequiredDescription

dataarrayrequiredArray of calculation parameters

deelmcp_hiring_insights_salary_calculate#Use this endpoint to retrieve a salary histogram for a specified job title and seniority level in a given country, returned in the requested currency and time scale.1 param▾

Use this endpoint to retrieve a salary histogram for a specified job title and seniority level in a given country, returned in the requested currency and time scale.

NameTypeRequiredDescription

dataarrayrequiredArray of salary data requests

deelmcp_hiring_insights_summary_get#Provides the best countries to hire talent based on your criteria, so you can make informed, strategic hiring decisions with confidence.7 params▾

Provides the best countries to hire talent based on your criteria, so you can make informed, strategic hiring decisions with confidence.

NameTypeRequiredDescription

job_titlestringrequiredThe job title for which you want to get hiring insights

senioritystringrequiredThe seniority level of the position

budgetnumberoptionalBudget limit for the position

budget_typestringoptionalType of budget calculation

priority_factorsarrayoptionalPriority factors to consider when filtering countries

regionsarrayoptionalGeographic regions to filter by

timezonesarrayoptionalTimezone offsets to filter by

deelmcp_hiring_insights_take_home_pay_calculate#Use this endpoint to estimate take-home pay for compensation inputs.1 param▾

Use this endpoint to estimate take-home pay for compensation inputs.

NameTypeRequiredDescription

dataarrayrequiredArray of salary items to process

deelmcp_hr_preview_offer_letter#Preview job offer letter1 param▾

Preview job offer letter

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

deelmcp_hr_suite_review_cycle_feedback_get#Retrieves review cycle feedback and competency data for an HRIS organization user, including categorized feedback entries (self-review, peer, upward, downward) and core competencies.2 params▾

Retrieves review cycle feedback and competency data for an HRIS organization user, including categorized feedback entries (self-review, peer, upward, downward) and core competencies.

NameTypeRequiredDescription

hris_organization_user_idstringrequiredA valid UUID v4 identifying the specific user.

review_cycle_idstringrequiredA valid UUID v4 identifying the review cycle.

deelmcp_hris_org_chart_get#Retrieves the organizational chart structure for an organization. Returns hierarchical trees of workers and optionally orphaned nodes (workers without managers).2 params▾

Retrieves the organizational chart structure for an organization. Returns hierarchical trees of workers and optionally orphaned nodes (workers without managers).

NameTypeRequiredDescription

group_bystringoptionalGrouping strategy for organizing the org chart.

group_by_valuestringoptionalOptional value to filter by when using specific grouping strategies.

deelmcp_hris_team_custom_field_update#Applies a partial update to custom field values on the specified team. Updates can be scheduled for a future effective date, and setting a field's value to `null` deletes that field value.2 params▾

Applies a partial update to custom field values on the specified team. Updates can be scheduled for a future effective date, and setting a field's value to `null` deletes that field value.

NameTypeRequiredDescription

dataobjectrequiredNo description.

team_idstringrequiredPublic ID (UUID) of the HRIS team/organization structure

deelmcp_ic_invoice_download#This endpoint provides embedded worker flows access to download a pdf of a specific invoice while using a worker:PAT token.1 param▾

This endpoint provides embedded worker flows access to download a pdf of a specific invoice while using a worker:PAT token.

NameTypeRequiredDescription

invoice_idstringrequiredPublic invoice identifier (UUID) for the invoice whose PDF URL is returned.

deelmcp_ic_invoice_get#This endpoint retrieves invoice information by ID. Use it to access detailed invoice data for reference or verification.1 param▾

This endpoint retrieves invoice information by ID. Use it to access detailed invoice data for reference or verification.

NameTypeRequiredDescription

invoice_idstringrequiredPublic invoice id for the invoice to return.

deelmcp_ic_invoice_list#This endpoint provides direct access to worker invoices via a worker token without requiring completion of the typical onboarding flow.0 params▾

This endpoint provides direct access to worker invoices via a worker token without requiring completion of the typical onboarding flow.

deelmcp_ic_legal_entity_setup#Independent contractors use this endpoint to complete legal-entity onboarding, triggering post-commit screening and background checks. Suitable for the IC Embedded flow in the public API.1 param▾

Independent contractors use this endpoint to complete legal-entity onboarding, triggering post-commit screening and background checks. Suitable for the IC Embedded flow in the public API.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_immigration_business_visa_eligibility_get#Analyzes nationality, residence, destination, and trip dates to return available business visa options with fees, timelines, and qualification criteria. Optional `second_nationality` expands eligibility.7 params▾

Analyzes nationality, residence, destination, and trip dates to return available business visa options with fees, timelines, and qualification criteria. Optional `second_nationality` expands eligibility.

NameTypeRequiredDescription

destination_countrystringrequiredThe destination country code of the trip in ISO 3166-1 alpha-2 format

nationalitystringrequiredThe nationality country code of the person in ISO 3166-1 alpha-2 format

residence_countrystringrequiredThe residence country code of the person in ISO 3166-1 alpha-2 format

trip_end_datestringrequiredThe trip end date in ISO 8601 format (YYYY-MM-DD)

trip_reasonstringrequiredThe reason for the trip

trip_start_datestringrequiredThe trip start date in ISO 8601 format (YYYY-MM-DD)

second_nationalitystringoptionalThe second nationality country code of the person in ISO 3166-1 alpha-2 format (optional)

deelmcp_immigration_case_create#Creates a new immigration case for a worker. The appropriate visa type must be determined before calling this endpoint.1 param▾

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

NameTypeRequiredDescription

datastringoptionalNo description.

deelmcp_immigration_case_document_get#Retrieves the details of a specific document requirement within a worker's immigration case, including the requirement's current status and information about any previously rejected document.2 params▾

Retrieves the details of a specific document requirement within a worker's immigration case, including the requirement's current status and information about any previously rejected document.

NameTypeRequiredDescription

case_idstringrequiredThe unique identifier of the case for which the required document is being requested.

worker_idstringrequiredThe hris profile oid (public id) of the worker.

deelmcp_immigration_case_document_upload#Uploads a document against a specific case document requirement and submits it for review.3 params▾

Uploads a document against a specific case document requirement and submits it for review.

NameTypeRequiredDescription

case_idstringrequiredThe unique identifier of the case for which the required document is being requested.

document_request_idstringrequiredThe unique identifier of the document request fo which this document is being uplodaded

worker_idstringrequiredThe hris profile oid (public id) of the worker.

deelmcp_immigration_case_get#Returns detailed information for a specific immigration case including applicant profile, visa type, status, estimated completion date, process details, and compliance documents.1 param▾

Returns detailed information for a specific immigration case including applicant profile, visa type, status, estimated completion date, process details, and compliance documents.

NameTypeRequiredDescription

case_idstringrequiredFilter by case ID

deelmcp_immigration_case_list#Retrieves a paginated list of immigration cases with filters for applicant name, case type, status, and country. Returns case details including type, status, process, timestamps, and optional closure information.6 params▾

Retrieves a paginated list of immigration cases with filters for applicant name, case type, status, and country. Returns case details including type, status, process, timestamps, and optional closure information.

NameTypeRequiredDescription

case_type_idsarrayoptionalFilter by case type IDs

countriesarrayoptionalFilter by country. Uses ISO 3166-1 alpha-2 codes (https://www.iban.com/country-codes).

cursorstringoptionalPagination cursor for fetching next set of results

limitintegeroptionalMax number of results to return

searchstringoptionalSearch by applicant name or code

statusesarrayoptionalFilter by case status

deelmcp_immigration_client_case_get#Retrieves the details of an immigration case by its case ID.1 param▾

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

NameTypeRequiredDescription

idstringrequiredImmigration case id

deelmcp_immigration_client_case_list#Returns a paginated list of immigration cases, optionally filtered by applicant name or code, case type, status, and country (ISO 3166-1 alpha-2). Use the `cursor` value from each response to retrieve the next page of results.6 params▾

Returns a paginated list of immigration cases, optionally filtered by applicant name or code, case type, status, and country (ISO 3166-1 alpha-2). Use the `cursor` value from each response to retrieve the next page of results.

NameTypeRequiredDescription

case_type_idsarrayoptionalFilter by case type IDs

countriesarrayoptionalFilter by country. Uses ISO 3166-1 alpha-2 codes (https://www.iban.com/country-codes).

cursorstringoptionalPagination cursor for fetching next set of results

limitintegeroptionalMax number of results to return

searchstringoptionalSearch by applicant name or code

statusesarrayoptionalFilter by case status

deelmcp_immigration_document_get#Retrieves the details of an immigration case document by its document `id`.1 param▾

Retrieves the details of an immigration case document by its document `id`.

NameTypeRequiredDescription

idstringrequiredImmigration case document id

deelmcp_immigration_onboarding_case_get#Returns the right-to-work onboarding case for a worker, including any associated documents; returns an empty response if no open case exists. When a worker is associated with multiple contracts, supply `contract_id` to target a specific contract.2 params▾

Returns the right-to-work onboarding case for a worker, including any associated documents; returns an empty response if no open case exists. When a worker is associated with multiple contracts, supply `contract_id` to target a specific contract.

NameTypeRequiredDescription

worker_idstringrequiredThe hris profile oid (public id) of the worker.

contract_idstringoptionalFilters the worker's onboarding case to a specific contract. If the worker has multiple contracts and this parameter is omitted, the response may return a case from any associated contract; the response includes contract.id to indicate which contract was used. Provide this parameter for deterministic results.

deelmcp_immigration_visa_requirement_get#Returns the necessity of a work visa for a specific country given the employee's nationalities.2 params▾

Returns the necessity of a work visa for a specific country given the employee's nationalities.

NameTypeRequiredDescription

country_codestringrequiredTwo-letter country code in ISO 3166-1 alpha-2 format for the country where the individual is employed

employee_nationalitiesstringrequiredList of employee nationalities in ISO 3166-1 alpha-2 format

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

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

NameTypeRequiredDescription

country_codestringrequiredAlpha 2 country code

deelmcp_industry_subcategories_list#Lists industry subcategories with their parent category details and NAICS codes, supporting cursor-based pagination and sorting by category or subcategory name.4 params▾

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

NameTypeRequiredDescription

cursorstringoptionalCursor used for paginating to the next page of results.

limitintegeroptionalMaximum number of items to return per page.

orderstringoptionalSorting order of the results.

sort_bystringoptionalField used to sort the results.

deelmcp_invoice_adjustment_create#Creates an invoice adjustment — such as a bonus, commission, VAT percentage, or deduction — against a contract. Pass the `recurring` query parameter to apply the adjustment automatically to future invoices.2 params▾

Creates an invoice adjustment — such as a bonus, commission, VAT percentage, or deduction — against a contract. Pass the `recurring` query parameter to apply the adjustment automatically to future invoices.

NameTypeRequiredDescription

dataobjectrequiredDetails of invoice adjustment to create.

recurringstringoptionalAdd this invoice adjustment as recurring

deelmcp_invoice_adjustment_delete#Permanently removes an invoice adjustment by its `id`.1 param▾

Permanently removes an invoice adjustment by its `id`.

NameTypeRequiredDescription

idstringrequiredInvoice adjustment id.

deelmcp_invoice_adjustment_get#Retrieves a single invoice line item by its `id`.1 param▾

Retrieves a single invoice line item by its `id`.

NameTypeRequiredDescription

idstringrequiredID of an existing invoice

deelmcp_invoice_adjustment_list#Returns invoice adjustments, optionally filtered by contract, adjustment type, status, invoice, reporter, or submission date range.10 params▾

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

NameTypeRequiredDescription

contract_idstringoptionalId of an Deel contract.

contract_typesarrayoptionalList of contract types

date_fromstringoptionalShort date in format ISO-8601 (YYYY-MM-DD). For example 2022-12-31.

date_tostringoptionalShort date in format ISO-8601 (YYYY-MM-DD). For example 2022-12-31.

invoice_idstringoptionalID of an existing invoice

limitstringoptionalReturn a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings

offsetstringoptionalReturn a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings

reporter_idstringoptionalID of an existing profile

statusesarrayoptionalstatuses of invoice adjustment to filter

typesarrayoptionaltypes of invoice adjustments to filter

deelmcp_invoice_adjustment_review#Submits an approve or decline review decision for a single invoice adjustment.2 params▾

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

NameTypeRequiredDescription

dataobjectrequiredNo description.

idstringrequiredID of an existing invoice adjustment.

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

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

NameTypeRequiredDescription

dataobjectrequiredDetails of adjustment to update

idstringrequiredInvoice adjustment id.

deelmcp_invoice_category_list#Returns the available adjustment categories, optionally filtered by contract type. Category IDs returned here are required when creating adjustments and define the type and accounting treatment applied.1 param▾

Returns the available adjustment categories, optionally filtered by contract type. Category IDs returned here are required when creating adjustments and define the type and accounting treatment applied.

NameTypeRequiredDescription

contract_typesarrayoptionalarray of contract types to filter categories

deelmcp_invoice_deel_invoice_list#Returns a paginated list of invoices for Deel platform fees.2 params▾

Returns a paginated list of invoices for Deel platform fees.

NameTypeRequiredDescription

limitstringoptionalReturn a page of results with given number of records; NOTE technically ALL query parameters are strings or array of strings

offsetstringoptionalReturn a page of results after given index of row; NOTE technically ALL query parameters are strings or array of strings'

deelmcp_invoice_download#Returns a temporary download URL for an invoice PDF; the URL expires at the time indicated by `expires_at` in the response.1 param▾

Returns a temporary download URL for an invoice PDF; the URL expires at the time indicated by `expires_at` in the response.

NameTypeRequiredDescription

idstringrequiredThe invoice ID used to identify the invoice to be downloaded.

deelmcp_invoice_get#Retrieves the details of a single invoice by `invoice_id`.1 param▾

Retrieves the details of a single invoice by `invoice_id`.

NameTypeRequiredDescription

invoice_idstringrequiredThe invoice ID used to identify the invoice to be retireved.

deelmcp_invoice_list#Returns a paginated list of invoices; by default only paid invoices are returned, but passing `status=all` returns invoices in all statuses. Supports both offset- and cursor-based pagination.7 params▾

Returns a paginated list of invoices; by default only paid invoices are returned, but passing `status=all` returns invoices in all statuses. Supports both offset- and cursor-based pagination.

NameTypeRequiredDescription

cursorstringoptionalReturn next page of results after the given cursor.

includestringoptionalWill include invoices from COR workers in the response.

issued_from_datestringoptionalFilter invoices issued on or after the specified date.

issued_to_datestringoptionalFilter invoices issued before the specified date.

limitnumberoptionalNumber of records to retrieve per page.

offsetnumberoptionalIndex of the first record to return.

statusstringoptionalIf status query has value of all, all invoices will be returned. Otherwise only paid invoices will be fetched.

deelmcp_invoice_payroll_adjustment_create#Creates a new payroll adjustment for a contract, modifying the payment amount on the next payment cycle. The `adjustment_category_id` must reference a valid category retrieved from `GET /adjustments/categories`.0 params▾

Creates a new payroll adjustment for a contract, modifying the payment amount on the next payment cycle. The `adjustment_category_id` must reference a valid category retrieved from `GET /adjustments/categories`.

deelmcp_invoice_payroll_adjustment_delete#Permanently deletes an adjustment by its id.1 param▾

Permanently deletes an adjustment by its id.

NameTypeRequiredDescription

idstringrequiredDeel adjustment id.

deelmcp_invoice_payroll_adjustment_get#Retrieves a specific adjustment by its id, including its amount, status, payment cycle dates, and associated contract_id.1 param▾

Retrieves a specific adjustment by its id, including its amount, status, payment cycle dates, and associated contract_id.

NameTypeRequiredDescription

idstringrequiredDeel adjustment id.

deelmcp_invoice_payroll_adjustment_update#Applies a partial update to an existing adjustment. Only fields included in the request body are modified; omitted fields retain their current values.1 param▾

Applies a partial update to an existing adjustment. Only fields included in the request body are modified; omitted fields retain their current values.

NameTypeRequiredDescription

idstringrequiredDeel adjustment id.

deelmcp_invoice_tax_create#Creates an invoicing tax entry for an independent contractor contract.2 params▾

Creates an invoicing tax entry for an independent contractor contract.

NameTypeRequiredDescription

contract_idstringrequiredDeel Contract ID

dataobjectoptionalNo description.

deelmcp_invoice_tax_delete#Permanently removes the specified `tax_type` from the contract's invoicing tax configuration; this action is irreversible and takes effect on future invoices.2 params▾

Permanently removes the specified `tax_type` from the contract's invoicing tax configuration; this action is irreversible and takes effect on future invoices.

NameTypeRequiredDescription

contract_idstringrequiredDeel Contract ID

tax_typestringrequiredIC tax type

deelmcp_invoice_tax_list#Retrieves the VAT and withholding tax settings configured for an independent contractor contract.1 param▾

Retrieves the VAT and withholding tax settings configured for an independent contractor contract.

NameTypeRequiredDescription

contract_idstringrequiredDeel Contract ID

deelmcp_invoice_tax_update#Applies a partial update to the invoicing tax for an independent contractor contract; accepts `tax_type` (WITHHOLDING_TAX or VAT) and `percentage` to modify how taxes are calculated on future invoices.2 params▾

Applies a partial update to the invoicing tax for an independent contractor contract; accepts `tax_type` (WITHHOLDING_TAX or VAT) and `percentage` to modify how taxes are calculated on future invoices.

NameTypeRequiredDescription

contract_idstringrequiredDeel Contract ID

dataobjectoptionalNo description.

deelmcp_it_asset_get#Retrieves the details of a specific IT asset by `asset_id`.1 param▾

Retrieves the details of a specific IT asset by `asset_id`.

NameTypeRequiredDescription

asset_idstringrequiredUnique identifier of the IT asset

deelmcp_it_asset_list#Returns a cursor-paginated list of all IT assets historically or currently managed by the organization.6 params▾

Returns a cursor-paginated list of all IT assets historically or currently managed by the organization.

NameTypeRequiredDescription

categorystringoptionalFilter assets by their product category

cursorstringoptionalIndicates where the next page of results starts, as returned in a paginated list response

hris_profile_idstringoptionalFilter assets by assigned worker with given HRIS Profile ID

limitintegeroptionalReturn a page of results with given number of records

locationstringoptionalFilter assets by their location

statusstringoptionalFilter assets by their status

deelmcp_it_order_get#Returns the status, shipping details, and associated product for a single IT equipment order identified by order_id.1 param▾

Returns the status, shipping details, and associated product for a single IT equipment order identified by order_id.

NameTypeRequiredDescription

order_idstringrequiredUnique identifier of the IT order

deelmcp_it_order_list#Returns a cursor-paginated list of all IT equipment orders for the organization, spanning both historical and current procurement requests.2 params▾

Returns a cursor-paginated list of all IT equipment orders for the organization, spanning both historical and current procurement requests.

NameTypeRequiredDescription

cursorstringoptionalIndicates where the next page of results starts, as returned in a paginated list response

limitintegeroptionalReturn a page of results with given number of records

deelmcp_it_policy_list#Returns all available IT hardware policies, which define the equipment eligible for ordering.0 params▾

Returns all available IT hardware policies, which define the equipment eligible for ordering.

deelmcp_knowledge_rag_config_create#Use this endpoint to create a new RAG (Retrieval-Augmented Generation) config for a team, that you can use to search using RAG Run Endpoint1 param▾

Use this endpoint to create a new RAG (Retrieval-Augmented Generation) config for a team, that you can use to search using RAG Run Endpoint

NameTypeRequiredDescription

dataobjectrequiredConfiguration object.

deelmcp_knowledge_rag_config_delete#Use this endpoint to delete a RAG (Retrieval-Augmented Generation) configuration by its ID. This action is destructive.1 param▾

Use this endpoint to delete a RAG (Retrieval-Augmented Generation) configuration by its ID. This action is destructive.

NameTypeRequiredDescription

config_idstringrequiredConfig Id for the RAG config

deelmcp_knowledge_rag_config_get#Use this endpoint to retrieve a RAG (Retrieval-Augmented Generation) configuration by its ID. Provide the config_id in the path. This is a read-only operation suitable for auditing or configuring clients.1 param▾

Use this endpoint to retrieve a RAG (Retrieval-Augmented Generation) configuration by its ID. Provide the config_id in the path. This is a read-only operation suitable for auditing or configuring clients.

NameTypeRequiredDescription

config_idstringrequiredConfig Id for the RAG config

deelmcp_knowledge_rag_config_list#Use this endpoint to retrieve all RAG (Retrieval-Augmented Generation) configuration using pagination. This is a read-only operation suitable for fetching all RAG configs.3 params▾

Use this endpoint to retrieve all RAG (Retrieval-Augmented Generation) configuration using pagination. This is a read-only operation suitable for fetching all RAG configs.

NameTypeRequiredDescription

cursorstringoptionalPagination cursor used to retrieve the next page of results.

fieldsarrayoptionalArray of fields to include in the response. Sent as multiple query parameters: fields=output_schema&fields=metadata

limitintegeroptionalMaximum number of items to return. Must be between 1 and 100.

deelmcp_knowledge_rag_config_run#Use this endpoint to run a retrieval-augmented query using the specified config_id2 params▾

Use this endpoint to run a retrieval-augmented query using the specified config_id

NameTypeRequiredDescription

config_idstringrequiredConfig Id for the RAG config

dataobjectrequiredNo description.

deelmcp_knowledge_rag_config_update#Use this endpoint to update an existing RAG (Retrieval-Augmented Generation) configuration2 params▾

Use this endpoint to update an existing RAG (Retrieval-Augmented Generation) configuration

NameTypeRequiredDescription

config_idstringrequiredConfig Id for the RAG config

dataobjectrequiredConfiguration object.

deelmcp_legal_entity_cost_center_synchronize#Update legal entity cost center's data to replicate the data provided on the request2 params▾

Update legal entity cost center's data to replicate the data provided on the request

NameTypeRequiredDescription

dataarrayrequiredNo description.

legal_entity_idstringrequiredLegal entity id

deelmcp_list_payroll_cycles#Use this endpoint to retrieve a list of payroll events for a specified legal entity.5 params▾

Use this endpoint to retrieve a list of payroll events for a specified legal entity.

NameTypeRequiredDescription

legal_entity_idstringrequiredThe unique identifier (public ID) for the legal entity.

cursorstringoptionalPagination cursor, CUID or UUID format.

date_endstringoptionalEnd date in the format 'YYYY-MM-DD'. Must not exceed 5 years in the future.

date_startstringoptionalStart date in the format 'YYYY-MM-DD'. Must not be earlier than 5 years ago.

limitintegeroptionalMaximum number of items to return.

deelmcp_lookup_country_list#Returns all countries supported by the platform, including each country's visa support status, Employer of Record availability, sub-territories, and classification.0 params▾

Returns all countries supported by the platform, including each country's visa support status, Employer of Record availability, sub-territories, and classification.

deelmcp_lookup_currency_list#Returns all currencies supported by the platform, including their ISO codes and names.0 params▾

Returns all currencies supported by the platform, including their ISO codes and names.

deelmcp_lookup_job_title_list#Returns the platform's catalogue of predefined job titles. Results are paginated using cursor-based navigation via `after_cursor`.1 param▾

Returns the platform's catalogue of predefined job titles. Results are paginated using cursor-based navigation via `after_cursor`.

NameTypeRequiredDescription

after_cursorstringoptionalCursor for pagination. Use this to retrieve the next page of results.

deelmcp_lookup_list#Returns reference data of the type specified by the `documents` query parameter; supported values are `currencies`, `countries`, `entity_types`, and `sic`.1 param▾

Returns reference data of the type specified by the `documents` query parameter; supported values are `currencies`, `countries`, `entity_types`, and `sic`.

NameTypeRequiredDescription

documentsstringrequiredThe type of lookup data to retrieve. Options are `currencies`, `countries`, `entity_types`, and `sic_numbers`.

deelmcp_lookup_seniority_list#Returns predefined seniority levels including their names, hierarchical positions, and identifiers. When `is_eor_contract` is `true`, C-level seniorities are excluded from the response.1 param▾

Returns predefined seniority levels including their names, hierarchical positions, and identifiers. When `is_eor_contract` is `true`, C-level seniorities are excluded from the response.

NameTypeRequiredDescription

is_eor_contractbooleanoptionalwhen `true`, exclude C-level seniorities for EOR contracts. Set to `false` to return all seniorities

deelmcp_lookup_timeoff_type_list#Returns the predefined time-off types available for registration on the platform.0 params▾

Returns the predefined time-off types available for registration on the platform.

deelmcp_milestone_create#Creates a new payment milestone on a milestone-based contract. After creation, the milestone enters a review workflow before payment is processed.2 params▾

Creates a new payment milestone on a milestone-based contract. After creation, the milestone enters a review workflow before payment is processed.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the Deel contract where the milestone will be added.

dataobjectrequiredNo description.

deelmcp_milestone_delete#Permanently deletes a specific milestone from a contract. This operation is irreversible and removes all associated milestone data.2 params▾

Permanently deletes a specific milestone from a contract. This operation is irreversible and removes all associated milestone data.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the Deel contract from which the milestone will be deleted.

milestone_idstringrequiredThe unique identifier of the milestone that is to be deleted.

deelmcp_milestone_get#Retrieves a single milestone identified by milestone_id within a specific contract.2 params▾

Retrieves a single milestone identified by milestone_id within a specific contract.

NameTypeRequiredDescription

contract_idstringrequiredDeel contract id.

milestone_idstringrequiredID of milestone to return

deelmcp_milestone_list#Retrieves all milestones associated with a specific contract, including each milestone's title, amount, status, relevant dates, and creator and reviewer information.1 param▾

Retrieves all milestones associated with a specific contract, including each milestone's title, amount, status, relevant dates, and creator and reviewer information.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the Deel contract for which milestones are being retrieved.

deelmcp_offboarding_tracker_get#Returns termination details for a contract identified by its offboarding tracker `id`.1 param▾

Returns termination details for a contract identified by its offboarding tracker `id`.

NameTypeRequiredDescription

idstringrequiredUnique onboarding tracker identifier

deelmcp_offboarding_tracker_hris_get#Returns termination details for a contract identified by its HRIS profile `oid`.1 param▾

Returns termination details for a contract identified by its HRIS profile `oid`.

NameTypeRequiredDescription

oidstringrequiredUnique hris profile oid

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

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

NameTypeRequiredDescription

hiring_typesarrayoptionalHiring type (e.g., contractor, employee)

ignore_date_rangebooleanoptionalIgnore the default 45-day date range and retrieve all terminations

include_overviewbooleanoptionalInclude an overview of the contract

limitintegeroptionalNumber of results to return per page

paginationobjectoptionalCursor-style pagination payload for the next page (pass values returned from the previous response).

progress_statusesarrayoptionalProgress status of the contract

searchstringoptionalSearch term to filter contracts by name or other attributes

sort_bystringoptionalField to sort by

sort_orderstringoptionalSorting order

deelmcp_onboarding_tracker_counter_get#Returns onboarding tracker counts grouped by status with a grand total, filtered by the caller's organization.15 params▾

Returns onboarding tracker counts grouped by status with a grand total, filtered by the caller's organization.

NameTypeRequiredDescription

actionsarrayoptionalNo description.

contractOidarrayoptionalNo description.

countriesarrayoptionalNo description.

fromDatestringoptionalNo description.

hiringTypesarrayoptionalNo description.

hrisDirectManagersarrayoptionalNo description.

includeOverviewbooleanoptionalNo description.

legalEntitiesarrayoptionalNo description.

limitintegeroptionalNo description.

progressStatusesarrayoptionalNo description.

searchstringoptionalNo description.

sortBystringoptionalNo description.

sortOrderstringoptionalNo description.

teamsarrayoptionalNo description.

toDatestringoptionalNo description.

deelmcp_onboarding_tracker_get#Returns a worker's onboarding status by `tracker_id`.1 param▾

Returns a worker's onboarding status by `tracker_id`.

NameTypeRequiredDescription

tracker_idstringrequiredThe unique identifier of the onboarding tracker.

deelmcp_onboarding_tracker_hris_get#Returns a worker's onboarding status by `hris_profile_id`.1 param▾

Returns a worker's onboarding status by `hris_profile_id`.

NameTypeRequiredDescription

hris_profile_idstringrequiredThe unique identifier of the employee HRIS profile.

deelmcp_onboarding_tracker_list#Returns a list of workers currently going through onboarding, including contract details, HRIS profile information, current onboarding status, and onboarding due dates. Supports cursor-based pagination.16 params▾

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

NameTypeRequiredDescription

actionsarrayoptionalOnboarding actions

contractOidarrayoptionalSearch attribute to filter onboarding list by contract id

countriesarrayoptionalSearch attribute to filter onboarding list by country

cursorstringoptionalCursor for pagination

fromDatestringoptionalStart date for filtering contracts

hiringTypesarrayoptionalSearch attribute to filter onboarding list by hiring type

hrisDirectManagersarrayoptionalSearch attribute to filter onboarding list by HRIS direct manager

include_overviewbooleanoptionalInclude an overview of the contract

legalEntitiesarrayoptionalSearch attribute to filter onboarding list by legal entity

limitintegeroptionalNumber of results to return per page

progressStatusesarrayoptionalSearch attribute to filter onboarding list by progress status

searchstringoptionalSearch term to filter contracts by name or other attributes

sort_bystringoptionalField to sort by

sort_orderstringoptionalSorting order

teamsarrayoptionalSearch attribute to filter onboarding list by team

toDatestringoptionalEnd date for filtering contracts

deelmcp_onboarding_worker_create#Complete the profile setup for independent contractors including address, tax details, and legal status in a single call during the IC-embedded onboarding flow. This operation requires a worker session token obtained via the worker session endpoint.1 param▾

Complete the profile setup for independent contractors including address, tax details, and legal status in a single call during the IC-embedded onboarding flow. This operation requires a worker session token obtained via the worker session endpoint.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_org_analytics_get#Executes an analytics query against the Cube backend. Use GET /organization/analytics/:entity_name/metadata first to fetch metadata for the specific entity, then use only the measures and dimensions returned for that entity.1 param▾

Executes an analytics query against the Cube backend. Use GET /organization/analytics/:entity_name/metadata first to fetch metadata for the specific entity, then use only the measures and dimensions returned for that entity.

NameTypeRequiredDescription

dataobjectrequiredRequest payload containing the Cube.js query and output format. The query specifies which dimensions, measures, and time_dimensions to retrieve from an analytics entity (e.g., people).

deelmcp_org_analytics_metadata_get#Returns metadata for an analytics entity (cube) including measures, dimensions, types, and formats. Use this to construct valid queries for `POST /organizations/analytics` — all query members must belong to the same entity.1 param▾

Returns metadata for an analytics entity (cube) including measures, dimensions, types, and formats. Use this to construct valid queries for `POST /organizations/analytics` — all query members must belong to the same entity.

NameTypeRequiredDescription

entity_namestringrequiredThe name of the analytics entity (cube) to retrieve metadata for.

deelmcp_org_analytics_tile_get#Creates a new analytics tile (chart, table, or text widget) for use on custom dashboards.1 param▾

Creates a new analytics tile (chart, table, or text widget) for use on custom dashboards.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_org_contract_custom_field_list#Returns custom field definitions for contracts — field metadata and placement for supported types (text, list, multiselect, number, percentage, currency, date), not contract-specific values.0 params▾

Returns custom field definitions for contracts — field metadata and placement for supported types (text, list, multiselect, number, percentage, currency, date), not contract-specific values.

deelmcp_org_cost_center_list#Returns all cost centers associated with the specified legal_entity_id.1 param▾

Returns all cost centers associated with the specified legal_entity_id.

NameTypeRequiredDescription

legal_entity_idstringrequiredLegal entity id

deelmcp_org_create_legal_entity#Creates a new legal entity under the organization and returns the entity record including its assigned id.1 param▾

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

NameTypeRequiredDescription

dataobjectoptionalNo description.

deelmcp_org_current_person_get#Returns the profile of the currently authenticated user, including identity, organizational membership, and integration identifiers for connected services such as Slack.0 params▾

Returns the profile of the currently authenticated user, including identity, organizational membership, and integration identifiers for connected services such as Slack.

deelmcp_org_current_person_profile_update#Applies a partial update to the authenticated user's profile, modifying only the fields supplied in the request body.1 param▾

Applies a partial update to the authenticated user's profile, modifying only the fields supplied in the request body.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_org_custom_field_get#"Retrieves a single person custom field definition by its `id`.1 param▾

"Retrieves a single person custom field definition by its `id`.

NameTypeRequiredDescription

idstringrequiredCustom field id.

deelmcp_org_custom_field_list#Returns custom field definitions for people - field metadata and placement for supported types (text, list, multiselect, number, percentage, currency, date), not person-specific values.0 params▾

Returns custom field definitions for people - field metadata and placement for supported types (text, list, multiselect, number, percentage, currency, date), not person-specific values.

deelmcp_org_delete_structure#Permanently removes an organization structure from the organization.1 param▾

Permanently removes an organization structure from the organization.

NameTypeRequiredDescription

external_idstringrequiredExternal ID

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

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

deelmcp_org_department_update#Assigns a worker to a department by their HRIS profile ID. By default the new assignment appends to existing positions; set `replace_other_positions` to true to replace all current positions instead.3 params▾

Assigns a worker to a department by their HRIS profile ID. By default the new assignment appends to existing positions; set `replace_other_positions` to true to replace all current positions instead.

NameTypeRequiredDescription

dataobjectrequiredNo description.

idstringrequiredHris profile ID

replace_other_positionsbooleanoptionalIndicates if this department position should replace all other positions or only append to the existing ones.

deelmcp_org_direct_employee_create#Creates a direct employee record under the organization's own legal entity, provisioning both a person and an employment contract. For onboarding employees managed through your own payroll providers.1 param▾

Creates a direct employee record under the organization's own legal entity, provisioning both a person and an employment contract. For onboarding employees managed through your own payroll providers.

NameTypeRequiredDescription

dataobjectrequiredNo description.

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

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

deelmcp_org_get_legal_entity#Returns legal entity data for an organization integrated with an external benefits vendor.1 param▾

Returns legal entity data for an organization integrated with an external benefits vendor.

NameTypeRequiredDescription

idstringrequiredId from the legal entity to fetch data

deelmcp_org_get_structure#Fetches a single organization structure, returning associated roles and teams alongside structure metadata.1 param▾

Fetches a single organization structure, returning associated roles and teams alongside structure metadata.

NameTypeRequiredDescription

external_idstringrequiredExternal ID

deelmcp_org_group_create#Creates a new group within the organization and returns the created group record, including its assigned `id`.1 param▾

Creates a new group within the organization and returns the created group record, including its assigned `id`.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_org_group_delete#Soft-deletes a group by archiving it. The group is not permanently removed and the response includes the `archived_at` timestamp reflecting when the archive occurred.1 param▾

Soft-deletes a group by archiving it. The group is not permanently removed and the response includes the `archived_at` timestamp reflecting when the archive occurred.

NameTypeRequiredDescription

idstringrequiredUnique identifier of the group to be archived.

deelmcp_org_group_list#Returns a paginated list of groups in the organization. Archived groups are included by default and can be excluded via the `include_archived_groups` parameter.5 params▾

Returns a paginated list of groups in the organization. Archived groups are included by default and can be excluded via the `include_archived_groups` parameter.

NameTypeRequiredDescription

cursorstringoptionalThe encoded cursor for paginated results. This is an opaque string that allows fetching the next set of results.

external_metadatastringoptionalExtra information about the group.

include_archived_groupsbooleanoptionalInclude archived groups (soft deleted records). Defaults to `true`.

limitintegeroptionalThe maximum number of groups to return (between 1 and 100)

sort_orderstringoptionalSort the results in ascending (ASC) or descending (DESC) order based on the group name.

deelmcp_org_group_update#Applies a partial update to an existing group's details. Only fields included in the request body are modified; omitted fields retain their current values.2 params▾

Applies a partial update to an existing group's details. Only fields included in the request body are modified; omitted fields retain their current values.

NameTypeRequiredDescription

dataobjectrequiredNo description.

idstringrequiredUnique identifier of the group to be edited.

deelmcp_org_hris_person_get#Returns detailed information about a single person in the organization by their public ID. Returns personal details, employment information, organizational structure, person status, direct manager, custom fields, and related data.3 params▾

Returns detailed information about a single person in the organization by their public ID. Returns personal details, employment information, organizational structure, person status, direct manager, custom fields, and related data.

NameTypeRequiredDescription

hris_profile_idstringrequiredUnique identifier for the person.

include_custom_fieldsbooleanoptionalInclude custom fields in the response.

include_worker_relationsbooleanoptionalInclude worker relations in the response.

deelmcp_org_legal_entity_delete#Archives the legal entity identified by id, marking it as inactive without permanently removing it; the response includes the archived_at timestamp.1 param▾

Archives the legal entity identified by id, marking it as inactive without permanently removing it; the response includes the archived_at timestamp.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the legal entity.

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

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

NameTypeRequiredDescription

countrystringoptionalFilter by country.

cursorstringoptionalCursor for pagination.

global_payrollbooleanoptionalFilter by global payroll flag.

include_archivedbooleanoptionalWhether to include archived legal entities in the results.

include_payroll_settingsbooleanoptionalWhether to include payroll settings in the response.

legal_entity_idstringoptionalFilter by specific legal entity ID.

limitintegeroptionalThe number of results to return per page.

sort_orderstringoptionalSorting order of the results.

typestringoptionalFilter by entity type.

deelmcp_org_manager_create#Creates a new manager in the organization and returns the created manager's identity fields, including the assigned `id`.1 param▾

Creates a new manager in the organization and returns the created manager's identity fields, including the assigned `id`.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_org_manager_list#Returns a paginated list of all managers in the organization.2 params▾

Returns a paginated list of all managers in the organization.

NameTypeRequiredDescription

limitintegeroptionalMaximum number of records to return per page.

offsetintegeroptionalThe starting index for the page of records to return.

deelmcp_org_person_custom_field_delete#Removes a specific custom field value from a worker record by the custom field's ID.2 params▾

Removes a specific custom field value from a worker record by the custom field's ID.

NameTypeRequiredDescription

idstringrequiredCustom field id.

worker_idstringrequiredWorker id.

deelmcp_org_person_custom_field_list#Returns all custom field values currently set for the specified worker.1 param▾

Returns all custom field values currently set for the specified worker.

NameTypeRequiredDescription

worker_idstringrequiredWorker id.

deelmcp_org_person_custom_field_update#Creates or updates a custom field value for a worker; if a value for the specified field already exists it is overwritten.2 params▾

Creates or updates a custom field value for a worker; if a value for the specified field already exists it is overwritten.

NameTypeRequiredDescription

dataobjectrequiredNo description.

worker_idstringrequiredWorker id.

deelmcp_org_person_list#Returns a paginated list of people records in the organization. Supports filtering by search term, teams, custom fields, and other query parameters. Build people directories, sync HR data, or power search interfaces across your workforce records.13 params▾

Returns a paginated list of people records in the organization. Supports filtering by search term, teams, custom fields, and other query parameters. Build people directories, sync HR data, or power search interfaces across your workforce records.

NameTypeRequiredDescription

band_placementsarrayoptionalEmployee's current band placement.

comparative_ratios_fromnumberoptionalEmployee's minimum band placement

comparative_ratios_tonumberoptionalEmployee's maximum band placement

fieldsarrayoptionalPick the fields you want to see in the response in order to avoid a bloated people list output. Supports dot notation (e.g., 'employments[0].contract_status') to access nested fields.

hiring_statusesarrayoptionalEmployee's current hiring status.

hiring_typesarrayoptionalFilter people by hiring types

limitintegeroptionalReturn a page of results with given number of records.

offsetintegeroptionalReturn a page of results with given number of records.

person_statusesarrayoptionalFilter people by person (worker profile) lifecycle status.

searchstringoptionalInclude a contract if by name or contractor name contains given search term.

sort_bystringoptionalSort people by given field name.

sort_orderstringoptionalOrder direction of results; ascending or descending.

teamsarrayoptionalFilter the results based on the team(group) the users contract is associated with

deelmcp_org_personal_info_get#Returns personal information for a worker by their worker ID.1 param▾

Returns personal information for a worker by their worker ID.

NameTypeRequiredDescription

worker_idstringrequiredUnique identifier for a worker (External ID).

deelmcp_org_personal_info_update#Partially updates personal information for a worker by their worker ID; only fields included in the request body are modified.2 params▾

Partially updates personal information for a worker by their worker ID; only fields included in the request body are modified.

NameTypeRequiredDescription

dataobjectrequiredNo description.

worker_idstringrequiredUnique identifier for a worker.

deelmcp_org_positions_list#Fetches all positions associated with the specified `hrisProfileId`.1 param▾

Fetches all positions associated with the specified `hrisProfileId`.

NameTypeRequiredDescription

hris_profile_idstringrequiredHRIS Profile ID

deelmcp_org_positions_update#Applies a batch of add, edit, and delete operations to positions within a single request. Multiple operation types may be submitted together; callers should ensure each operation in the batch targets a valid, existing position where applicable.1 param▾

Applies a batch of add, edit, and delete operations to positions within a single request. Multiple operation types may be submitted together; callers should ensure each operation in the batch targets a valid, existing position where applicable.

NameTypeRequiredDescription

dataobjectoptionalThe request payload containing the position changes to apply.

deelmcp_org_relation_type_create#Creates a new worker relation type, defining a named parent–child relationship structure that can be applied to worker associations. The `is_default` flag on the response indicates whether the created type has been set as the default relation type.1 param▾

Creates a new worker relation type, defining a named parent–child relationship structure that can be applied to worker associations. The `is_default` flag on the response indicates whether the created type has been set as the default relation type.

NameTypeRequiredDescription

dataobjectoptionalNo description.

deelmcp_org_relation_type_delete#Permanently deletes the worker relation type. This operation is irreversible; ensure no active worker relations are associated with the type before calling.1 param▾

Permanently deletes the worker relation type. This operation is irreversible; ensure no active worker relations are associated with the type before calling.

NameTypeRequiredDescription

type_idstringrequiredWorker Relation Type ID

deelmcp_org_relation_type_list#Returns all configured worker relation types available in the organization, which define the valid relationship categories that can be assigned when creating or upserting worker relations.0 params▾

Returns all configured worker relation types available in the organization, which define the valid relationship categories that can be assigned when creating or upserting worker relations.

deelmcp_org_role_create#Creates a new custom role within the current organization.1 param▾

Creates a new custom role within the current organization.

NameTypeRequiredDescription

dataobjectoptionalNo description.

deelmcp_org_role_list#Retrieves all roles defined within the current organization.0 params▾

Retrieves all roles defined within the current organization.

deelmcp_org_role_update#Applies a partial update to the custom role, modifying only the fields supplied in the request body.2 params▾

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

NameTypeRequiredDescription

roleIdstringrequiredID of the role

dataobjectoptionalNo description.

deelmcp_org_structure_delete#Permanently removes an organization structure from the organization.1 param▾

Permanently removes an organization structure from the organization.

NameTypeRequiredDescription

hris_org_structure_idstringrequiredOrg Structure

deelmcp_org_structure_get#Fetches a single organization structure by its `hrisOrgStr_id`, returning associated roles, teams, and structure metadata.1 param▾

Fetches a single organization structure by its `hrisOrgStr_id`, returning associated roles, teams, and structure metadata.

NameTypeRequiredDescription

hris_org_structure_idstringrequiredHRIS Organization Structure ID

deelmcp_org_structure_update#Applies a partial update to an existing organization structure. Only fields provided in the request body are modified; omitted fields retain their current values.2 params▾

Applies a partial update to an existing organization structure. Only fields provided in the request body are modified; omitted fields retain their current values.

NameTypeRequiredDescription

hris_org_structure_idstringrequiredOrg Structure

dataobjectoptionalNo description.

deelmcp_org_structures_create#Creates a new organization structure, returning the record with its assigned `id`. The `is_multi_select` and `enable_roles` flags control multi-team assignment and role management support.1 param▾

Creates a new organization structure, returning the record with its assigned `id`. The `is_multi_select` and `enable_roles` flags control multi-team assignment and role management support.

NameTypeRequiredDescription

dataobjectoptionalNo description.

deelmcp_org_structures_list#Returns the organization's hierarchical structure, including departments and teams, with offset-based pagination.2 params▾

Returns the organization's hierarchical structure, including departments and teams, with offset-based pagination.

NameTypeRequiredDescription

limitnumberoptionalReturn a page of results with given number of records.

offsetnumberoptionalReturn a page of results with given number of records.

deelmcp_org_task_list#Returns a paginated list of all tasks for the organization, not limited to the caller. Supports offset/limit and cursor-based pagination, which are mutually exclusive — do not combine `cursor` with offset.6 params▾

Returns a paginated list of all tasks for the organization, not limited to the caller. Supports offset/limit and cursor-based pagination, which are mutually exclusive — do not combine `cursor` with offset.

NameTypeRequiredDescription

categorystringoptionalFilter by task category.

cursorstringoptionalOpaque cursor for cursor-based pagination. When provided, use with limit only (do not use offset).

external_idstringoptionalFilter by external ID (for tasks created with an external reference).

limitintegeroptionalMaximum number of records to return (1-100).

searchstringoptionalSearch string for task display name or description.

statusesarrayoptionalFilter by task statuses.

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

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

deelmcp_org_update_legal_entity#Applies a partial update to an existing legal entity identified by id; only fields included in the request body are modified.8 params▾

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

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the legal entity.

addressobjectoptionalNo description.

company_identifiersobjectoptionalIdentifiers associated with the legal entity.

entity_typestringoptionalThe type of the legal entity.

industry_namestringoptionalThe industry name of the legal entity.

namestringoptionalThe name of the legal entity.

phonestringoptionalThe phone number of the legal entity.

sic_numberstringoptionalThe SIC number of the legal entity.

deelmcp_org_update_structure#Applies a partial update to an existing organization structure. Only fields provided in the request body are modified; omitted fields retain their current values.2 params▾

Applies a partial update to an existing organization structure. Only fields provided in the request body are modified; omitted fields retain their current values.

NameTypeRequiredDescription

external_idstringrequiredExternal ID

dataobjectoptionalNo description.

deelmcp_org_worker_relation_create#Establishes a hierarchical relationship between a worker and one or more subordinates. The request body must identify both the parent worker and the subordinate profiles to be linked.1 param▾

Establishes a hierarchical relationship between a worker and one or more subordinates. The request body must identify both the parent worker and the subordinate profiles to be linked.

NameTypeRequiredDescription

dataobjectoptionalThe request payload containing the relationship details.

deelmcp_org_worker_relations_child_update#Creates or replaces the child worker relation for the HrisProfile. If a child relation already exists for this profile, it is overwritten with the supplied data.2 params▾

Creates or replaces the child worker relation for the HrisProfile. If a child relation already exists for this profile, it is overwritten with the supplied data.

NameTypeRequiredDescription

hris_profile_oidstringrequiredHrisProfile ID

dataobjectoptionalNo description.

deelmcp_org_working_location_list#Returns the list of available work location labels for the organization. Populate options when creating or editing people or contract records.0 params▾

Returns the list of available work location labels for the organization. Populate options when creating or editing people or contract records.

deelmcp_org_working_location_update#Sets the working location for a worker identified by their HRIS profile ID.2 params▾

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

NameTypeRequiredDescription

dataobjectrequiredNo description.

idstringrequiredHris profile ID

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

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

NameTypeRequiredDescription

payment_idstringrequiredUnique identifier for the payment to retrieve the breakdown.

deelmcp_payout_auto_withdrawal_get#Returns the current auto-withdrawal configuration for the authenticated worker, including whether auto-withdrawal is enabled and the identifier of the selected withdrawal method.0 params▾

Returns the current auto-withdrawal configuration for the authenticated worker, including whether auto-withdrawal is enabled and the identifier of the selected withdrawal method.

deelmcp_payout_auto_withdrawal_update#Partially updates the auto-withdrawal configuration, allowing callers to enable or disable auto-withdrawal and change the target withdrawal method.1 param▾

Partially updates the auto-withdrawal configuration, allowing callers to enable or disable auto-withdrawal and change the target withdrawal method.

NameTypeRequiredDescription

dataobjectoptionalNo description.

deelmcp_payout_balance_list#Returns the total available balances for the authenticated contractor, broken down by currency and aggregated into a single cross-currency total.0 params▾

Returns the total available balances for the authenticated contractor, broken down by currency and aggregated into a single cross-currency total.

deelmcp_payout_bank_transfer_method_update#Fully replaces the bank transfer method; all method fields must be provided as this is a complete replacement, not a partial update.2 params▾

Fully replaces the bank transfer method; all method fields must be provided as this is a complete replacement, not a partial update.

NameTypeRequiredDescription

dataobjectrequiredNo description.

idstringrequiredMethod unique identifier

deelmcp_payout_bank_transfer_route_list#Returns all bank transfer routes available to the authenticated contractor.0 params▾

Returns all bank transfer routes available to the authenticated contractor.

deelmcp_payout_contractor_auto_withdrawal_update#Updates the auto-withdrawal configuration for the authenticated contractor.1 param▾

Updates the auto-withdrawal configuration for the authenticated contractor.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_payout_employee_method_create#Creates or updates an employee's bank payout method. If a method already exists, the existing record is superseded and the response includes a version identifier and activation status reflecting the updated state.1 param▾

Creates or updates an employee's bank payout method. If a method already exists, the existing record is superseded and the response includes a version identifier and activation status reflecting the updated state.

NameTypeRequiredDescription

dataobjectoptionalRequest data

deelmcp_payout_employee_method_delete#Permanently removes the bank payout method identified by the given method `id`.1 param▾

Permanently removes the bank payout method identified by the given method `id`.

NameTypeRequiredDescription

idstringrequiredmethod ID

deelmcp_payout_employee_method_list#Retrieves the configured bank payout methods for an employee.0 params▾

Retrieves the configured bank payout methods for an employee.

deelmcp_payout_transfer_method_create#Registers a new bank transfer payout method; the request payload structure is dynamic and determined by the selected option, so callers should retrieve field requirements before submitting.1 param▾

Registers a new bank transfer payout method; the request payload structure is dynamic and determined by the selected option, so callers should retrieve field requirements before submitting.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_payout_transfer_method_list#Returns all payout methods associated with the authenticated account, with optional filtering to return only the default method.1 param▾

Returns all payout methods associated with the authenticated account, with optional filtering to return only the default method.

NameTypeRequiredDescription

is_defaultbooleanoptionalFilter by whether the method is default. If true, only default methods will be returned.

deelmcp_payout_withdrawal_request#Initiates a withdrawal of available funds to the employee's configured payout method. The operation is asynchronous; the outcome is delivered via webhook rather than the synchronous response.1 param▾

Initiates a withdrawal of available funds to the employee's configured payout method. The operation is asynchronous; the outcome is delivered via webhook rather than the synchronous response.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_payout_withdrawal_tracking_get#Retrieve the step-by-step tracking information for a withdrawal, including current progress, status steps, and any delay banners.2 params▾

Retrieve the step-by-step tracking information for a withdrawal, including current progress, status steps, and any delay banners.

NameTypeRequiredDescription

idstringrequiredWithdrawal ID (numeric sequential ID or UUID v4 public ID)

profileIdstringoptionalContractor profile public ID (UUID). Required when the caller is a client/org admin. Specifies which contractor's withdrawal to look up.

deelmcp_payroll_contract_create#Creates a new Global Payroll contract. Country-specific required fields must be retrieved first from `GET /forms/gp/worker-additional-fields/{country_code}`. Returns the contract with its `id`.1 param▾

Creates a new Global Payroll contract. Country-specific required fields must be retrieved first from `GET /forms/gp/worker-additional-fields/{country_code}`. Returns the contract with its `id`.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_payroll_cycle_gross_to_net_get#Returns categorized gross-to-net data — including category group, category, sub-category, and label — for each contract within the payroll cycle identified by `cycle_id`.3 params▾

Returns categorized gross-to-net data — including category group, category, sub-category, and label — for each contract within the payroll cycle identified by `cycle_id`.

NameTypeRequiredDescription

cycle_idstringrequiredThe unique identifier for the payroll event.

cursorstringoptionalCursor for pagination of results.

limitintegeroptionalMaximum number of items to return. Defaults to 20.

deelmcp_payroll_cycle_list#Lists payroll cycles with optional filters for contract OIDs, date range, country, entity, and cycle state. Use `employment_id` to narrow results to specific employee contracts.9 params▾

Lists payroll cycles with optional filters for contract OIDs, date range, country, entity, and cycle state. Use `employment_id` to narrow results to specific employee contracts.

NameTypeRequiredDescription

cursorstringoptionalCursor for pagination.

cycle_action_statesarrayoptionalFilter by cycle action state.

cycle_typesarrayoptionalFilter by cycle type.

cycles_tabstringoptionalFilter cycles by tab.

employment_idstringoptionalContract OID(s) from people endpoint employments[0].id.

end_datestringoptionalEnd of date range.

exclude_completedbooleanoptionalExclude completed cycles.

limitintegeroptionalMaximum number of cycles to return.

start_datestringoptionalStart of date range.

deelmcp_payroll_equity_tax_event_create#Submits an equity or token tax event for an EOR worker enrolled in Equity & Token Services.1 param▾

Submits an equity or token tax event for an EOR worker enrolled in Equity & Token Services.

NameTypeRequiredDescription

dataobjectoptionalNo description.

deelmcp_payroll_payment_cycle_list#Fetches the scheduled payment dates and current status of each payment cycle for a specific contract.1 param▾

Fetches the scheduled payment dates and current status of each payment cycle for a specific contract.

NameTypeRequiredDescription

contract_idstringrequiredThe Deel contract ID for which payment dates are being retrieved.

deelmcp_payroll_report_entry_update#Updates payroll report items for an employee in a specific cycle. Ensure the cycle is editable before submitting. Provide `payroll_report_column_id` values from the payroll report response.3 params▾

Updates payroll report items for an employee in a specific cycle. Ensure the cycle is editable before submitting. Provide `payroll_report_column_id` values from the payroll report response.

NameTypeRequiredDescription

cycle_idstringrequiredPayroll event/cycle id.

dataobjectrequiredNo description.

payroll_report_entry_idstringrequiredPayroll report entry id, unique for each employee for each cycle.

deelmcp_payroll_report_get#Get payroll report data for a payroll cycle, including available columns, employee row values, and optional previous report items. Use this response to discover payroll_report_column_id and payroll_id before updating entries.6 params▾

Get payroll report data for a payroll cycle, including available columns, employee row values, and optional previous report items. Use this response to discover payroll_report_column_id and payroll_id before updating entries.

NameTypeRequiredDescription

cycle_idstringrequiredPayroll event/cycle id.

contract_oidsarrayoptionalContract OID(s) to filter report rows.

cursorstringoptionalCursor for pagination.

employee_statusarrayoptionalEmployee status filter.

limitintegeroptionalMaximum number of report rows.

searchstringoptionalFilter by employee name.

deelmcp_raw_shift_update#Update specific fields of an existing raw shift by its unique `external_id`. This includes shift meta details, description etc.2 params▾

Update specific fields of an existing raw shift by its unique `external_id`. This includes shift meta details, description etc.

NameTypeRequiredDescription

dataobjectrequiredRaw shift update request data.

external_idstringrequiredUnique identifier of the shift to be updated.

deelmcp_retrieve_ats_job_posting_by_organization#This endpoint retrieves a single job posting by its ID for a specific organization. It provides detailed information about the job posting, including its associated job details, publication status, and other relevant metadata.2 params▾

This endpoint retrieves a single job posting by its ID for a specific organization. It provides detailed information about the job posting, including its associated job details, publication status, and other relevant metadata.

NameTypeRequiredDescription

job_posting_idstringrequiredUnique identifier of the job posting to retrieve

organization_idstringrequiredUnique identifier of the organization

deelmcp_retrieve_ats_job_postings_by_organization#Retrieves a list of all job postings in the Applicant Tracking System. Results can be filtered by query parameters.4 params▾

Retrieves a list of all job postings in the Applicant Tracking System. Results can be filtered by query parameters.

NameTypeRequiredDescription

organization_idstringrequiredUnique identifier of the organization

cursorstringoptionalThe cursor for pagination (optional)

job_board_idstringoptionalJob Board ID must be a valid UUID

limitintegeroptionalMaximum number of records returned in one response (optional)

deelmcp_retrieve_custom_fields_for_organization#Retrieves custom field values for a specific organization structure (team). This endpoint returns all custom fields configured for organization structures, including their current values, inheritance status, and any pending change requests. Custom fields3 params▾

Retrieves custom field values for a specific organization structure (team). This endpoint returns all custom fields configured for organization structures, including their current values, inheritance status, and any pending change requests. Custom fields

NameTypeRequiredDescription

team_idstringrequiredPublic ID (UUID) of the HRIS team/organization structure

cursorstringoptionalOpaque cursor for pagination

limitintegeroptionalMax items per page (default 20, max 100)

deelmcp_retrieve_payment_receipts#Retrieve a list of payments made to Deel, including worker details, payment status, and payment methods.6 params▾

Retrieve a list of payments made to Deel, including worker details, payment status, and payment methods.

NameTypeRequiredDescription

currenciesarrayoptionalFilters payments by their currency codes. Can be a single currency code or an array of codes.

cursorstringoptionalA cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results.

date_fromstringoptionalFilters results to include payments created on or after this date (in ISO 8601 format).

date_tostringoptionalFilters results to include payments created before this date (in ISO 8601 format).

entitiesarrayoptionalFilters payments by legal entity type (e.g., 'individual' or 'company'). Can be a single entity type or an array.

statusesarrayoptionalFilters payments by their status (e.g., 'paid' or 'processing'). Can be a single status type or an array.

deelmcp_system_profile_list#Use this endpoint to retrieve a list of Deel users along with their connected system accounts (Slack, GitHub, Jira).2 params▾

Use this endpoint to retrieve a list of Deel users along with their connected system accounts (Slack, GitHub, Jira).

NameTypeRequiredDescription

emailarrayoptionalOne or more emails to match exactly; repeat the param (?email=a@x.com&email=b@y.com). At least one of 'email' or 'name' must be provided.

namearrayoptionalOne or more names (case-insensitive partial match); repeat the param (?name=John&name=Doe). At least one of 'email' or 'name' must be provided.

deelmcp_task_update#Applies a partial update to the specified task and returns whether the update was successful.2 params▾

Applies a partial update to the specified task and returns whether the update was successful.

NameTypeRequiredDescription

dataobjectrequiredNo description.

task_idstringrequiredThe id of an existing task

deelmcp_time_tracking_raw_shift_create#Submits one or more raw shift records to the time tracking system. Raw shifts represent unprocessed time entries that may undergo validation or transformation before being reflected in processed time data.1 param▾

Submits one or more raw shift records to the time tracking system. Raw shifts represent unprocessed time entries that may undergo validation or transformation before being reflected in processed time data.

NameTypeRequiredDescription

dataobjectrequiredRequest data containing contract ID and shifts to be created.

deelmcp_time_tracking_shift_bulk_delete#Permanently deletes one or more shifts identified by their external IDs. Deleted shifts are immediately unrecoverable and can no longer be retrieved or modified.1 param▾

Permanently deletes one or more shifts identified by their external IDs. Deleted shifts are immediately unrecoverable and can no longer be retrieved or modified.

NameTypeRequiredDescription

dataobjectrequiredRequest data containing the external IDs of shifts to be deleted.

deelmcp_time_tracking_shift_create#Creates one or more time tracking shifts for a contract in a single request. Supports both original shift submissions and correction shifts that adjust hours for previously processed shifts.1 param▾

Creates one or more time tracking shifts for a contract in a single request. Supports both original shift submissions and correction shifts that adjust hours for previously processed shifts.

NameTypeRequiredDescription

dataobjectrequiredRequest data containing contract ID and shifts to be created.

deelmcp_time_tracking_shift_external_delete#Permanently deletes a shift identified by its external_id. Once deleted, the shift cannot be retrieved or modified.1 param▾

Permanently deletes a shift identified by its external_id. Once deleted, the shift cannot be retrieved or modified.

NameTypeRequiredDescription

external_idstringrequiredThe unique external identifier of the shift to be deleted.

deelmcp_time_tracking_shift_external_get#Retrieves the details of a specific shift.1 param▾

Retrieves the details of a specific shift.

NameTypeRequiredDescription

external_idstringrequiredUnique identifier of the shift to retrieve.

deelmcp_time_tracking_shift_external_update#Applies a partial update to an existing shift, modifying only the fields supplied in the request body. Fields omitted from the request are left unchanged.2 params▾

Applies a partial update to an existing shift, modifying only the fields supplied in the request body. Fields omitted from the request are left unchanged.

NameTypeRequiredDescription

dataobjectrequiredShift update request data.

external_idstringrequiredUnique identifier of the shift to be updated.

deelmcp_time_tracking_shift_list#Returns a paginated list of shifts. Results can be scoped to one or more contracts and bounded by a date range using `from_date` and `to_date`.5 params▾

Returns a paginated list of shifts. Results can be scoped to one or more contracts and bounded by a date range using `from_date` and `to_date`.

NameTypeRequiredDescription

contract_idarrayoptionalFilter shifts by one or more contract IDs.

from_datestringoptionalFilter shifts from this date (YYYY-MM-DD).

limitstringoptionalMaximum number of records to return.

offsetstringoptionalOffset/index of record for the next page of records to return.

to_datestringoptionalFilter shifts until this date (YYYY-MM-DD).

deelmcp_time_tracking_shift_rate_create#Creates a new shift rate with a specified name, type, value, and an externally supplied identifier that can be used to correlate the rate with records in external systems.1 param▾

Creates a new shift rate with a specified name, type, value, and an externally supplied identifier that can be used to correlate the rate with records in external systems.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_time_tracking_shift_rate_external_delete#Deletes a shift rate identified by its external_id, which is the custom identifier assigned at creation time. Deletion is blocked if the shift rate is currently associated with any active shift.1 param▾

Deletes a shift rate identified by its external_id, which is the custom identifier assigned at creation time. Deletion is blocked if the shift rate is currently associated with any active shift.

NameTypeRequiredDescription

external_idstringrequiredexternal ID

deelmcp_time_tracking_shift_rate_external_get#Retrieves a shift rate.1 param▾

Retrieves a shift rate.

NameTypeRequiredDescription

external_idstringrequiredThe unique external identifier of the shift rate to retrieve.

deelmcp_time_tracking_shift_rate_external_update#Applies a partial update to an existing shift rate, modifying only the fields provided in the request body.2 params▾

Applies a partial update to an existing shift rate, modifying only the fields provided in the request body.

NameTypeRequiredDescription

dataobjectrequiredNo description.

external_idstringrequiredUnique identifier of the shift rate to be updated.

deelmcp_time_tracking_shift_rate_list#Returns a paginated list of shift rates. Use the limit and offset parameters to control page size and starting position within the result set.2 params▾

Returns a paginated list of shift rates. Use the limit and offset parameters to control page size and starting position within the result set.

NameTypeRequiredDescription

limitstringoptionalThe maximum number of records to return per page. For example, '10' to return up to 10 records.

offsetstringoptionalThe starting index for the records to retrieve. For example, '0' for the first page or '10' for the second page when limit=10.

deelmcp_time_tracking_timesheet_get#Retrieves a timesheet by `timesheet_id`, including its submission, review, and processing status. Pass `expand=file_data` to include file name and download URL in the response.2 params▾

Retrieves a timesheet by `timesheet_id`, including its submission, review, and processing status. Pass `expand=file_data` to include file name and download URL in the response.

NameTypeRequiredDescription

timesheet_idstringrequiredID of the timesheet to fetch file for

extendstringoptionalOptional 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.

deelmcp_time_tracking_timesheet_review#Approves or rejects a submitted timesheet; only timesheets in `PENDING_REVIEW` status are eligible, and all associated hours are approved or rejected as a single operation.2 params▾

Approves or rejects a submitted timesheet; only timesheets in `PENDING_REVIEW` status are eligible, and all associated hours are approved or rejected as a single operation.

NameTypeRequiredDescription

dataobjectrequiredNo description.

timesheet_idstringrequiredID of the timesheet to review

deelmcp_time_tracking_timesheet_upload_url_generate#Accepts timesheet file metadata and returns a pre-signed `upload_url` together with a new timesheet record `id`. Currently limited to EOR contracts.1 param▾

Accepts timesheet file metadata and returns a pre-signed `upload_url` together with a new timesheet record `id`. Currently limited to EOR contracts.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_timeoff_all_event_list#Returns time-off events for a worker profile identified by hris_profile_id, with optional filtering by time_off_type_id or policy_id.3 params▾

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

NameTypeRequiredDescription

hris_profile_idstringrequiredWorker hris profile id

policy_idstringoptionalPolicy id

time_off_type_idstringoptionalTime off type id

deelmcp_timeoff_dailies_list#Returns holidays, work schedule entries, and time-off dailies for a given date range, scoped to one or more HRIS profile IDs or countries.4 params▾

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

NameTypeRequiredDescription

countriesarrayoptionalList of countries to be fetched

end_datestringoptionalEnd date of non working days date range

hris_profile_idsarrayoptionalHRIS profile ids

start_datestringoptionalStart date of non working days date range

deelmcp_timeoff_entitlement_list#Returns time-off entitlements for the specified hris_profile_id, including available balances, used days, and remaining allocation per time-off type. Results can be scoped to a specific policy type or tracking period date.3 params▾

Returns time-off entitlements for the specified hris_profile_id, including available balances, used days, and remaining allocation per time-off type. Results can be scoped to a specific policy type or tracking period date.

NameTypeRequiredDescription

hris_profile_idstringrequiredHRIS profile ID

policy_type_namestringoptionalPolicy type name

tracking_period_datestringoptionalTracking period date

deelmcp_timeoff_event_list#Returns a paginated list of time-off requests for the specified hris_profile_id, with optional filters for status, policy type, date ranges covering the time-off period, approval date, and last-updated date.12 params▾

Returns a paginated list of time-off requests for the specified hris_profile_id, with optional filters for status, policy type, date ranges covering the time-off period, approval date, and last-updated date.

NameTypeRequiredDescription

hris_profile_idstringrequiredHRIS profile id

approval_end_datestringoptionalApproval end date

approval_start_datestringoptionalApproval start date

end_datestringoptionalEnd date of time off

nextstringoptionalNext page

page_sizeintegeroptionalPage size

policy_typesarrayoptionalPolicy types

start_datestringoptionalStart date of time off

statusarrayoptionalTime off status

time_off_idsarrayoptionalTime off ids

updated_end_datestringoptionalUpdated end date

updated_start_datestringoptionalUpdated start date

deelmcp_timeoff_policy_list#Returns the time-off policies assigned to the specified hris_profile_id, including policy details such as allowed types, accrual rules, and balances. Results can be filtered by policy type name or policy type ID.3 params▾

Returns the time-off policies assigned to the specified hris_profile_id, including policy details such as allowed types, accrual rules, and balances. Results can be filtered by policy type name or policy type ID.

NameTypeRequiredDescription

hris_profile_idstringrequiredhrisProfileId id.

policy_type_idstringoptionalpolicy type id

policy_type_namestringoptionalPolicy type name.

deelmcp_timeoff_policy_validation_template_list#Returns policy validation templates and policy types for one or more countries, specified as ISO 3166-1 alpha-2 codes. Policy types in the response are unique across the result set.1 param▾

Returns policy validation templates and policy types for one or more countries, specified as ISO 3166-1 alpha-2 codes. Policy types in the response are unique across the result set.

NameTypeRequiredDescription

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

deelmcp_timeoff_request_create#Creates a new time-off request for a worker.1 param▾

Creates a new time-off request for a worker.

NameTypeRequiredDescription

dataobjectoptionalThe time off request data

deelmcp_timeoff_request_delete#Cancels the time-off request identified by time_off_id, setting its status to CANCELED regardless of its current state.1 param▾

Cancels the time-off request identified by time_off_id, setting its status to CANCELED regardless of its current state.

NameTypeRequiredDescription

time_off_idstringrequiredTime off request id

deelmcp_timeoff_request_list#Returns time-off requests for the authenticated organization, with optional filtering by status, date ranges, policy types, and specific request IDs. Results are paginated using cursor-based navigation.12 params▾

Returns time-off requests for the authenticated organization, with optional filtering by status, date ranges, policy types, and specific request IDs. Results are paginated using cursor-based navigation.

NameTypeRequiredDescription

approval_end_datestringoptionalApproval end date

approval_start_datestringoptionalApproval start date

end_datestringoptionalEnd date of time off

include_deleted_time_offsbooleanoptionalWhen true, includes soft-deleted time-off records in the response. Deleted records will have a deleted_at timestamp and status DELETED.

nextstringoptionalNext page

page_sizeintegeroptionalPage size

policy_typesarrayoptionalPolicy types

start_datestringoptionalStart date of time off

statusarrayoptionalTime off status

time_off_idsarrayoptionalTime off ids

updated_end_datestringoptionalUpdated end date

updated_start_datestringoptionalUpdated start date

deelmcp_timeoff_request_review#Approves or rejects a batch of time-off requests in a single call. The desired status must be either APPROVED or REJECTED for each entry; the response distinguishes successfully processed requests from those that encountered errors.1 param▾

Approves or rejects a batch of time-off requests in a single call. The desired status must be either APPROVED or REJECTED for each entry; the response distinguishes successfully processed requests from those that encountered errors.

NameTypeRequiredDescription

dataarrayrequiredArray of time-offs to be reviewed

deelmcp_timeoff_request_update#Applies a partial update to an existing time-off request identified by time_off_id. Only fields included in the request body are modified.2 params▾

Applies a partial update to an existing time-off request identified by time_off_id. Only fields included in the request body are modified.

NameTypeRequiredDescription

time_off_idstringrequiredTime off request id

dataobjectoptionalTime off update request data

deelmcp_timeoff_request_validate#Validates a time-off request against policy compliance, available balance, blackout dates, and other rules before creation. Returns an `is_valid` flag with any errors and adjusted dates.1 param▾

Validates a time-off request against policy compliance, available balance, blackout dates, and other rules before creation. Returns an `is_valid` flag with any errors and adjusted dates.

NameTypeRequiredDescription

dataobjectoptionalTime off request data

deelmcp_timeoff_sync_run#Synchronizes time-off requests from an external HRIS for Global Payroll contracts. Records are upserted or deleted by external ID. Deel calculates the payroll cycle impact of each operation.1 param▾

Synchronizes time-off requests from an external HRIS for Global Payroll contracts. Records are upserted or deleted by external ID. Deel calculates the payroll cycle impact of each operation.

NameTypeRequiredDescription

dataobjectoptionalNo description.

deelmcp_timesheet_create#Creates a timesheet entry for an hourly contractor, recording the contract, date, hours worked, and an optional description. The entry is immediately placed into a review workflow upon creation.1 param▾

Creates a timesheet entry for an hourly contractor, recording the contract, date, hours worked, and an optional description. The entry is immediately placed into a review workflow upon creation.

NameTypeRequiredDescription

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

deelmcp_timesheet_create_reviews#Review a batch of timesheets to approve or reject submitted work.1 param▾

Review a batch of timesheets to approve or reject submitted work.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_timesheet_delete#Permanently deletes a timesheet entry. An optional `reason` query parameter may be provided to record the rationale for deletion.2 params▾

Permanently deletes a timesheet entry. An optional `reason` query parameter may be provided to record the rationale for deletion.

NameTypeRequiredDescription

idstringrequiredID of an existing timesheet

reasonstringoptionalReason for deleting an existing task

deelmcp_timesheet_get#Returns a single timesheet entry.1 param▾

Returns a single timesheet entry.

NameTypeRequiredDescription

idstringrequiredID of an existing timesheet

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

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

NameTypeRequiredDescription

contract_idstringoptionalFilter results to timesheets belonging to this Deel contract ID.

contract_typesarrayoptionalList of contract types

date_fromstringoptionalShort date in format ISO-8601 (YYYY-MM-DD). For example 2022-12-31.

date_tostringoptionalShort date in format ISO-8601 (YYYY-MM-DD). For example 2022-12-31.

limitstringoptionalMaximum number of records to return per page. NOTE: query parameters are passed as strings.

offsetstringoptionalNumber of records to skip before starting to return results. NOTE: query parameters are passed as strings.

reporter_idstringoptionalFilter results to timesheets submitted by this user ID.

statusesarrayoptionalList of statuses to filter by

deelmcp_timesheet_preset_create#Creates a new hourly report preset, returning the assigned id upon success.1 param▾

Creates a new hourly report preset, returning the assigned id upon success.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_timesheet_preset_delete#Permanently deletes an hourly report preset identified by id.1 param▾

Permanently deletes an hourly report preset identified by id.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the hourly report preset to delete

deelmcp_timesheet_preset_get#Retrieves a single hourly report preset by its id.1 param▾

Retrieves a single hourly report preset by its id.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the hourly report preset to retrieve

deelmcp_timesheet_preset_list#Returns saved hourly report presets for the specified contract, optionally scoped to a work statement. Results support cursor-based pagination and can be ordered by title or creation date.6 params▾

Returns saved hourly report presets for the specified contract, optionally scoped to a work statement. Results support cursor-based pagination and can be ordered by title or creation date.

NameTypeRequiredDescription

contract_idstringrequiredID of the Deel contract

cursorstringoptionalPagination cursor for fetching next set of results

limitintegeroptionalNumber of results to return per page

order_bystringoptionalField to order results by (title or created_at)

order_directionstringoptionalDirection of ordering (ASC or DESC)

work_statement_idstringoptionalID of the work statement (optional)

deelmcp_timesheet_preset_update#Applies a partial update to an existing hourly report preset identified by id. Only fields included in the request body are modified.2 params▾

Applies a partial update to an existing hourly report preset identified by id. Only fields included in the request body are modified.

NameTypeRequiredDescription

dataobjectrequiredNo description.

idstringrequiredThe unique identifier of the hourly report preset to update

deelmcp_timesheet_review#Submits an approve or reject decision for a timesheet entry. Approved timesheets are queued for inclusion in the next payment cycle.2 params▾

Submits an approve or reject decision for a timesheet entry. Approved timesheets are queued for inclusion in the next payment cycle.

NameTypeRequiredDescription

idstringrequiredID of an existing timesheet

dataobjectoptionalNo description.

deelmcp_timesheet_root_preset_alt_get#Retrieves a single hourly report root preset by its id, including its current status.1 param▾

Retrieves a single hourly report root preset by its id, including its current status.

NameTypeRequiredDescription

idstringrequiredThe unique identifier of the hourly report root preset to retrieve

deelmcp_timesheet_root_preset_async_create#Creates a new hourly report root preset and initiates asynchronous processing; the response includes an async_task object that can be used to track completion.6 params▾

Creates a new hourly report root preset and initiates asynchronous processing; the response includes an async_task object that can be used to track completion.

NameTypeRequiredDescription

titlestringrequiredThe title of the hourly report root preset (maximum 255 characters)

descriptionstringoptionalDetailed description of the root preset's purpose and usage (maximum 30000 characters)

filestringoptionalOptional file attachment for the root preset

hourly_report_presetsarrayoptionalArray of preset configurations to be created along with the root preset

hourly_report_presets_processing_typestringoptionalDetermines whether presets should be processed synchronously or asynchronously

typestringoptionalThe type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate

deelmcp_timesheet_root_preset_async_list#Returns a cursor-paginated list of hourly report root presets, with optional filtering by work_statement_statuses and result ordering.5 params▾

Returns a cursor-paginated list of hourly report root presets, with optional filtering by work_statement_statuses and result ordering.

NameTypeRequiredDescription

cursorstringoptionalPagination cursor for fetching the next page of results

limitintegeroptionalMaximum number of items to return per page (max: 100)

order_bystringoptionalField to order the results by

order_directionstringoptionalDirection to order the results (ascending or descending)

work_statement_statusesarrayoptionalFilter results by work statement status

deelmcp_timesheet_update#Partially updates an existing timesheet entry; only fields supplied in the request body are modified. Both clients and contractors may perform this operation.2 params▾

Partially updates an existing timesheet entry; only fields supplied in the request body are modified. Both clients and contractors may perform this operation.

NameTypeRequiredDescription

dataobjectrequiredNo description.

idstringrequiredID of an existing timesheet.

deelmcp_update_worker_relation_type#Update a worker relation type.2 params▾

Update a worker relation type.

NameTypeRequiredDescription

typeIdstringrequiredWorker Relation Type id

dataobjectoptionalNo description.

deelmcp_update_worker_relation_type_external_id#Update a worker relation type by external id.2 params▾

Update a worker relation type by external id.

NameTypeRequiredDescription

externalIdstringrequiredWorker Relation Type external ID

dataobjectoptionalNo description.

deelmcp_upsert_parent_worker_relations#Create a parent worker relation.2 params▾

Create a parent worker relation.

NameTypeRequiredDescription

hrisProfileOidstringrequiredHrisProfile ID

dataobjectoptionalNo description.

deelmcp_verification_aml_get#Returns the most recent AML screening result for the specified entity. The `entity_type` must be one of `profile`, `hris_profile`, or `legal_entity`.2 params▾

Returns the most recent AML screening result for the specified entity. The `entity_type` must be one of `profile`, `hris_profile`, or `legal_entity`.

NameTypeRequiredDescription

entity_idstringrequiredUUID v4 of the entity

entity_typestringrequiredThe type of entity to screen. Only 'profile', 'hris_profile', 'legal_entity' are accepted.

deelmcp_verification_kyc_get#Retrieves KYC verification details for a worker identified by `worker_profile_id` or `profile_id`; these two parameters are mutually exclusive. `contract_id` is required when multiple profiles are associated with the worker.3 params▾

Retrieves KYC verification details for a worker identified by `worker_profile_id` or `profile_id`; these two parameters are mutually exclusive. `contract_id` is required when multiple profiles are associated with the worker.

NameTypeRequiredDescription

contract_idstringoptionalWorker'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

profile_idstringoptionalWorker's profile public ID client requests to fetch KYC details for, This parameter is mutually exclusive with worker_profile_id

worker_profile_idstringoptionalWorker's HRIS profile public ID client requests to fetch KYC details for. This parameter is mutually exclusive with profile_id

deelmcp_verification_method_get#Returns the KYC verification method supported for a given combination of issuing country and document type.2 params▾

Returns the KYC verification method supported for a given combination of issuing country and document type.

NameTypeRequiredDescription

countrystringrequiredThe document's issuing country code (ISO 3166-1 alpha-2)

document_typestringrequiredThe document to be provided during KYC

deelmcp_verification_screening_create#Creates a manual identity verification submission as a fallback when automated verification has failed multiple times or when the document's country of issue is not supported by the automated solution.0 params▾

Creates a manual identity verification submission as a fallback when automated verification has failed multiple times or when the document's country of issue is not supported by the automated solution.

deelmcp_vms_candidate_message_create#Use this endpoint to handle new candidate's chat message received from an external provider. Provide the job and candidate identifiers and message text. The system will save text and show it to client as candidate's chat message.1 param▾

Use this endpoint to handle new candidate's chat message received from an external provider. Provide the job and candidate identifiers and message text. The system will save text and show it to client as candidate's chat message.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_vms_candidate_update#Handles a candidate action event from an external provider by updating the candidate state and triggering corresponding platform workflows.1 param▾

Handles a candidate action event from an external provider by updating the candidate state and triggering corresponding platform workflows.

NameTypeRequiredDescription

dataobjectrequiredNo description.

deelmcp_worker_amendment_sign#Records the worker's signature on a pending amendment identified by amendment_id. Once signed, the amendment's status change is reflected in the associated contract.2 params▾

Records the worker's signature on a pending amendment identified by amendment_id. Once signed, the amendment's status change is reflected in the associated contract.

NameTypeRequiredDescription

amendment_idstringrequiredThe unique identifier of the amendment to sign

dataobjectoptionalNo description.

deelmcp_worker_compliance_document_list#Retrieve the list of compliance document requirements for a worker, grouped by country. Returns all required and optional documents with their current submission status. Applicable for both independent contractors and EOR employees.0 params▾

Retrieve the list of compliance document requirements for a worker, grouped by country. Returns all required and optional documents with their current submission status. Applicable for both independent contractors and EOR employees.

deelmcp_worker_contract_sign#Records the worker's signature on the contract identified by contract_id. Only contracts in an unsigned, pending state can be signed.2 params▾

Records the worker's signature on the contract identified by contract_id. Only contracts in an unsigned, pending state can be signed.

NameTypeRequiredDescription

contract_idstringrequiredThe unique identifier of the contract.

dataobjectrequiredNo description.

deelmcp_worker_contract_type_list#Returns the additional information template for a given contract type and employment country, specifying the fields required to complete employee information for that combination.2 params▾

Returns the additional information template for a given contract type and employment country, specifying the fields required to complete employee information for that combination.

NameTypeRequiredDescription

countrystringrequiredISO 3166-1 alpha-2 country code.

typestringrequiredThe contract type. Must be 'eor' (Employer of Record) or 'gp' (Global Payroll).

deelmcp_worker_document_download#Get the download link of worker document.2 params▾

Get the download link of worker document.

NameTypeRequiredDescription

document_idstringrequiredUnique identifier for a compliance document in Deel.

worker_idstringrequiredUnique identifier for a worker.

deelmcp_worker_document_list#Retrieve a list of documents of a worker.1 param▾

Retrieve a list of documents of a worker.

NameTypeRequiredDescription

worker_idstringrequiredUnique identifier for a worker.

deelmcp_worker_hrx_manager_get#Retrieves the Human Resource Experience (HRX) Manager assigned to the authenticated worker, including contact details and a scheduling URL. Accessible only to workers with the appropriate permissions.0 params▾

Retrieves the Human Resource Experience (HRX) Manager assigned to the authenticated worker, including contact details and a scheduling URL. Accessible only to workers with the appropriate permissions.

deelmcp_worker_personal_info_external_get#Retrieves a worker profile record using a system-wide external worker identifier.1 param▾

Retrieves a worker profile record using a system-wide external worker identifier.

NameTypeRequiredDescription

worker_idstringrequiredSystem-wide external identifier for a worker record.

deelmcp_workflow_action_trigger#Add workflow actions to a workflow created by AI Agents1 param▾

Add workflow actions to a workflow created by AI Agents

NameTypeRequiredDescription

dataobjectrequiredActions configuration data containing an array of workflow actions

deelmcp_workflow_trigger#Creates an internal invisible workflow with a trigger1 param▾

Creates an internal invisible workflow with a trigger

NameTypeRequiredDescription

dataobjectrequiredTrigger configuration data