With this app, ChatGPT helps you plan global hiring with Deel. Compare hiring model costs, estimate total employer cost, and estimate employee take-home pay. You also get country-specific insights and salary context, backed by Deel’s coverage in 150+ countries and 2,000+ in-country experts.
About Deel: Deel helps teams hire, pay, and manage workers in 150+ countries
For planning only. Not legal or tax advice.
AddOffCyclePaymentForContractAdd a new invoice line-item for the purpose of an off-cycle payment associated with a specific contract. This is typically used for exceptional payments outside the regular payment schedule
contract_idstringThe unique identifier (ID) of the Deel contract for which the off-cycle payment is being created.
dataobjectaddWorkflowActionsAdd workflow actions to a workflow created by AI Agents
dataobjectActions configuration data containing an array of workflow actions
addWorkflowTriggerCreates an internal invisible workflow with a trigger
dataobjectTrigger configuration data
amendContractAmend the details of a contract. Please note that if the contract is already signed or active, then the update will have to be approved and re-signed for to take effect.
contract_idstringThe unique identifier of the employee contract.
dataobjectYou can specify any combination of data points that need changing.
calculateEmploymentCostDetermine the total employment cost for an Employee of Record (EOR) arrangement, including salary, employer costs, benefits, and additional fees, for a single employee in a single country. Do not use for multi-country comparisons. Use calculateEmploymentCostForMultipleCountries instead.
dataobjectcalculateEmploymentCostForMultipleCountriesDetermine the total employment costs for an Employee of Record (EOR) arrangement across multiple country scenarios, including salary, employer costs, benefits, and additional fees. Use this for multi-country comparisons in one call. Do not use for a single-country estimate.
dataarrayArray of employee cost calculation requests.
calculateEorVersusEntityHiringCostsUse this endpoint to compare EOR and local entity options for international hiring.
dataarrayArray of calculation parameters
calculateTakeHomePayUse this endpoint to estimate take-home pay for compensation inputs.
dataarrayArray of salary items to process
cancelTimeOffRequestCancel a time-off request. Use only when the user explicitly asks to cancel an existing request. Do not use for informational questions.
time_off_idstringTime off request id
checkVisaRequirementReturns the necessity of a work visa for a specific country given the employee's nationalities.
country_codestringTwo-letter country code in ISO 3166-1 alpha-2 format for the country where the individual is employed
employee_nationalitiesstringList of employee nationalities in ISO 3166-1 alpha-2 format
createAnalyticsTileCreates a new analytics tile (chart, table, or text widget) for use on custom dashboards.
dataobjectcreateANewContractCreate a new Deel contract for non-EOR contract types (fixed, pay-as-you-go, milestone, ongoing). Use only when the user explicitly asks to create a contract. For EOR contracts, use createContractForEOR instead.
datacreateContractForEORCreate an Employee of Record (EOR) contract quote. Use after all EOR inputs are collected. This submits contract details and returns a quote. It does not sign or finalize the contract.
dataobjectcreateDirectEmployeePayrollContractCreate a Global Payroll contract.
dataobjectcreateInvoiceAdjustmentCreate an invoice adjustment using this endpoint. For example, you can add a bonus, commission, VAT %, deduction etc. to an invoice. This endpoint requires invoice-adjustments:write scope
dataobjectDetails of invoice adjustment to create.
recurringstringAdd this invoice adjustment as recurring
createTimeOffRequestCreate a time-off request for a worker. Use only when the user explicitly asks to create a new time-off request. Do not use for informational questions about requests, policies, balances, or schedules.
dataobjectThe time off request data
downloadEmployeeComplianceDocumentTemplateGet the download link for an employee compliance document template, if it exists.
document_idstringUnique identifier for a compliance document in Deel.
downloadSubmittedComplianceDocumentGet the download link for an employee's submitted compliance document.
document_idstringUnique identifier for a compliance document in Deel.
getAdjustmentsGet all adjustments for the specific contract.
contract_idstringDeel adjustment id.
fromstringFilter adjustments by start date.
tostringFilter adjustments by end date.
getAdvanceEligibilityCheckRetrieve information related to advance eligibility checks
getAnalyticsMetadataByEntityNameRetrieves detailed metadata for a single analytics entity. Use this metadata to construct valid queries for the POST endpoint.
entity_namestringThe name of the analytics entity (cube) to retrieve metadata for.
peoplecontractsinvoicestime_off_requestscompensationonboardingtime_trackingterminationspayroll_g2n_itemsgross_to_netimmigrationatsexpensesimmigration_tracked_documentsbenefitsimmigration_feesequitygross_to_net_cost_centerspeople_dailytime_off_summarypeople_historyreview_cycle_answersaudit_logsclient_paymentsworker_bank_detailsreview_cycle_tasksworkforce_planninggetBulkContractUpdateExecutionReturns the current status and row-level failures for a bulk contract update execution.
execution_idstringBulk contract update execution public ID.
getContractPaymentDatesFetches a list of payment dates associated with a specific contract. This endpoint provides information on when contractors are scheduled to be paid, along with the current status of each payment cycle.
contract_idstringThe Deel contract ID for which payment dates are being retrieved.
getCurrentOrganizationRetrieve details of the current organization associated with the authenticated user
getCustomFieldFromPeopleByIdGet custom field from people by id.
idstringCustom field id.
getCustomFieldsFromPeopleList all custom fields.
GetCustomFieldValuesFromWorkerRetrieve custom fields for a worker.
worker_idstringWorker id.
getDetailedPaymentsReportRetrieve the detailed payment report in JSON format.
from_datestringFiltered results will include records created on or after the provided date.
to_datestringFiltered results will include records created before the provided date.
limitnumberReturn a page of results with given number of records; NOTE technically ALL query parameters are strings or array of strings
offsetnumberReturn a page of results after given index of row; NOTE technically ALL query parameters are strings or array of strings'
getEORContractBenefitsRetrieve Benefits for EOR Contract.
contract_idstringThe unique identifier of the EOR contract.
getEorCountryValidationsRetrieve detailed hiring guide for a country.
country_codestringCountry code in ISO Alpha-2 format.
getEORWorkerPayslipsRetrieve employee payslip records for an EOR worker
worker_idstringThe ID of the worker whose payslips are being retrieved.
getGPWorkerPayslipsRetrieve a list of payslips for a Global Payroll employee
idstringUnique identifier for the worker in UUID format.
getHiringInsightsReportSummaryProvides the best countries to hire talent based on your criteria, so you can make informed, strategic hiring decisions with confidence.
job_titlestringThe job title for which you want to get hiring insights
senioritystringThe seniority level of the position
JUNIORMIDDLESENIORbudgetnumberBudget limit for the position
budget_typestringType of budget calculation
GROSS_ANNUAL_SALARYTOTAL_COSTpriority_factorsarrayPriority factors to consider when filtering countries
regionsarrayGeographic regions to filter by
timezonesarrayTimezone offsets to filter by
getHrisOrganizationStructuresRetrieves comprehensive details of an organization's hierarchical structure, including departments and teams, within the Human Resources Information System (HRIS) domain
limitnumberReturn a page of results with given number of records.
offsetnumberReturn a page of results with given number of records.
getHrisProfilePersonRetrieve a single person's details within the organization using their HRIS profile identifier. Use only when you already have hris_profile_id. Do not use for email lookup, external ID lookup, or general people search.
hris_profile_idstringUnique identifier for the person.
include_custom_fieldsbooleanInclude custom fields in the response.
include_worker_relationsbooleanInclude worker relations in the response.
getInvoiceAdjustmentsRetrieve invoice adjustments. You can filter the list by providing additional parameters e.g. contract_id, contract_type etc.
contract_idstringId of an Deel contract.
contract_typesarraytypes of contracts to filter
date_fromstringShort date in format ISO-8601 (YYYY-MM-DD). For example 2022-12-31.
date_tostringShort date in format ISO-8601 (YYYY-MM-DD). For example 2022-12-31.
invoice_idstringID of an existing invoice
limitstringReturn a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings
offsetstringReturn a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings
reporter_idstringID of an existing profile
statusesarraystatuses of invoice adjustment to filter
typesarraytypes of invoice adjustments to filter
getInvoiceByIdRetrieve invoice details
invoice_idstringThe invoice ID used to identify the invoice to be retireved.
getInvoiceListRetrieve a list of paid invoices for your workforce.
cursorstringReturn next page of results after the given cursor.
includestringWill include invoices from COR workers in the response.
corissued_from_datestringFilter invoices issued on or after the specified date.
issued_to_datestringFilter invoices issued before the specified date.
limitnumberNumber of records to retrieve per page.
offsetnumberIndex of the first record to return.
statusstringIf status query has value of all, all invoices will be returned. Otherwise only paid invoices will be fetched.
allgetLegalEntityListRetrieve a list of legal entities in your account
countrystringFilter by country.
cursorstringCursor for pagination.
global_payrollbooleanFilter by global payroll flag.
include_archivedbooleanWhether to include archived legal entities in the results.
include_payroll_settingsbooleanWhether to include payroll settings in the response.
legal_entity_idstringFilter by specific legal entity ID.
limitintegerThe number of results to return per page.
sort_orderstringSorting order of the results.
ASCDESCtypestringFilter by entity type.
getListOfPeopleRetrieve a list of people in your organization. Use for browsing, filtering, or fuzzy people search across the organization. Do not use when a unique identifier such as hris_profile_id or email is already known and a single-person lookup is intended.
band_placementsarrayEmployee's current band placement.
comparative_ratios_fromnumberEmployee's minimum band placement
comparative_ratios_tonumberEmployee's maximum band placement
fieldsarrayPick 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_statusesarrayEmployee's current hiring status.
hiring_typesarrayFilter people by hiring types
limitintegerReturn a page of results with given number of records.
offsetintegerReturn a page of results with given number of records.
person_statusesarrayFilter people by person (worker profile) lifecycle status.
searchstringInclude a contract if by name or contractor name contains given search term.
sort_bystringSort people by given field name.
idfirst_namelast_namefull_nameemailcountrybirth_datehiring_typestart_dateteamjob_titlehiring_statuscompletion_datedirect_managerdirect_reports_countband_placementcomparative_ratiosort_orderstringOrder direction of results; ascending or descending.
ascdescteamsarrayFilter the results based on the team(group) the users contract is associated with
getLoggedInUserProfileRetrieves the profile information of the currently authenticated user
getLookupsRetrieve lookup information such as countries, entity types, or SIC numbers. Use the documents parameter to specify which data to retrieve.
documentsstringThe type of lookup data to retrieve. Options are `currencies`, `countries`, `entity_types`, and `sic_numbers`.
sicNumbersentityTypescountriesgetOffCyclePaymentByContractIdRetrieves a specific off-cycle payment for a contract using the Deel platform. Part of the workforce management suite, it aids in tracking and managing payment discrepancies outside the regular payroll cycle
contract_idstringDeel contract id.
idstringDeel off-cycle payment id.
getOffCyclePaymentsByContractIdRetrieves a list of off-cycle payments associated with a specific contract ID on the Deel platform. Off-cycle payments refer to disbursements made outside the regular payroll schedule, typically for exceptional or one-time expenses.
contract_idstringThe unique identifier (ID) of the Deel contract for which to retrieve off-cycle payments.
getOnboardingDetailsByEmployeeHrisProfileIdUse this endpoint to retrieve a comprehensive overview of a worker's onboarding status, including their profile details, contract status, and checklist progress.
hris_profile_idstringThe unique identifier of the employee HRIS profile.
getPayrollReportGet payroll report data of a specific cycle, including available columns and employee row values.
cycle_idstringPayroll event/cycle id.
contract_oidsarrayContract OID(s) to filter report rows.
cursorstring/numberCursor for pagination.
employee_statusarrayEmployee status filter.
limitintegerMaximum number of report rows.
searchstringFilter by employee name.
getPeoplePersonalInformationByExternalIdGet personal information by external id.
worker_idstringUnique identifier for a worker (External ID).
getPolicyValidationTemplatesGet unique policy validation templates and policy types for the provided countries
countriesarrayList of countries (ISO 3166-1 alpha-2 codes) to fetch policy templates and types for.
getProfileEntitlementsGet time-off entitlements for a profile. Use to retrieve entitlement balances or accrual information for a profile. Do not use for submitted requests, policy definitions, or holiday or work schedule information.
hris_profile_idstringHRIS profile ID
policy_type_namestringPolicy type name
Moving leaveAdoption leavePersonal leaveParental leaveMilitary leaveChildbirth leaveStudy leaveSick leaveBereavement leaveFamily & domestic violence leaveMarriage/wedding leaveBlood donation leaveVolunteer leaveVacationDoctor's appointment leaveMaternity leaveHajj leavePaternity leaveCivic/public duty leaveChildcare leaveUnpaid leavePaid leaveOther leaveDisability leavePregnancy leaveRTTRegional holidayBreastfeeding leaveAdvanced vacationtracking_period_datestringTracking period date
getSalaryHistogramForARoleInMultiplesCountriesUse 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.
dataarrayArray of salary data requests
getShiftByExternalIdRetrieve details of a specific shift using its external ID
external_idstringUnique identifier of the shift to retrieve.
getShiftRateByExternalIdRetrieve details of a specific shift rate using its external ID
external_idstringThe unique external identifier of the shift rate to retrieve.
getShiftRatesRetrieve a paginated list of shift rates
limitstringThe maximum number of records to return per page. For example, '10' to return up to 10 records.
offsetstringThe starting index for the records to retrieve. For example, '0' for the first page or '10' for the second page when limit=10.
getShiftsRetrieve a paginated list of shifts with filters
contract_idarrayFilter shifts by one or more contract IDs.
from_datestringFilter shifts from this date (YYYY-MM-DD).
limitstringMaximum number of records to return.
offsetstringOffset/index of record for the next page of records to return.
to_datestringFilter shifts until this date (YYYY-MM-DD).
getTeamListRetrieve a list of teams within the organization associated with the authenticated user.
getTimeOffPoliciesList time-off policies for a given HRIS profile. Use to retrieve the policies available to a profile. Do not use for submitted requests, entitlement balances, or holiday or work schedule information.
hris_profile_idstringhrisProfileId id.
policy_type_idstringpolicy type id
policy_type_namestringPolicy type name.
Moving leaveAdoption leavePersonal leaveParental leaveMilitary leaveChildbirth leaveStudy leaveSick leaveBereavement leaveFamily & domestic violence leaveMarriage/wedding leaveBlood donation leaveVolunteer leaveVacationDoctor's appointment leaveMaternity leaveHajj leavePaternity leaveCivic/public duty leaveChildcare leaveUnpaid leavePaid leaveOther leaveDisability leavePregnancy leaveRTTRegional holidayBreastfeeding leaveAdvanced vacationgetTimeOffRequestsList time-off requests for a specific HRIS profile. Use to retrieve submitted or historical time-off requests. Do not use for policy rules, entitlement balances, or holiday or work schedule information.
hris_profile_idstringHRIS profile id
approval_end_datestringApproval end date
approval_start_datestringApproval start date
end_datestringEnd date of time off
nextstringNext page
page_sizeintegerPage size
policy_typesarrayPolicy types
start_datestringStart date of time off
statusarrayTime off status
time_off_idsarrayTime off ids
updated_end_datestringUpdated end date
updated_start_datestringUpdated start date
getTimeoffTypeListRetrieve a list of predefined time-off types that can be registered in the Deel platform.
getWorkScheduleAndHolidaysGiven a date range (start_date, end_date), retrieve holidays, work schedule, and time-off dailies for a list of hris_profile_ids or countries. Use for calendar, holiday, or work schedule questions. Do not use for entitlement balances, policy definitions, or submitted request history.
countriesarrayList of countries to be fetched
end_datestringEnd date of non working days date range
hris_profile_idsarrayHRIS profile ids
start_datestringStart date of non working days date range
immigrationCaseDetailsFetch immigration case details by case id
idstringImmigration case id
immigrationDocumentFetch immigration document details by document id
idstringImmigration case document id
immigrationVisaTypesFetch immigration supported visa types by country
country_codestringAlpha 2 country code
listContractAmendmentsRetrieve amendments of a contract
contract_idstringUnique identifier of the contract
cursorstringCursor for pagination.
limitintegerMaximum number of work statements to return.
sign_statusesarrayFilter by work statement sign status.
statusesarrayFilter by work statement status.
listEmploymentComparisonsAcrossCountriesUse this endpoint to compare employment regulations, costs, time off, and payroll details across one or more countries for hiring analysis.
categoriesarrayComparison categories to include
countriesarrayCountry codes to compare (ISO 3166-1 alpha-2)
currencystringTarget currency (ISO 4217); when provided, amounts inside text are converted
cursorstringCursor for pagination to fetch the next page of results
draftstringDraft version of the data
limitnumberMaximum number of results to return
listItAssetsRetrieve a paginated list of all IT assets managed by the organization. This is useful for getting a complete overview of your equipment inventory and understanding the state of each asset.
categorystringFilter assets by their product category
ADAPTERCABLECHAIRCHARGERDESKDESK_RISERDESK_TIDYDESKTOPDOCKING_STATIONDONGLEFOOTRESTHEADSETKEYBOARDLAPTOPLAPTOP_STANDMICE_TRACKPADMOBILE_DEVICEMONITORMONITOR_ARMOTHERPRINTERSHREDDERSTANDING_MATTABLETTASK_LIGHTWEBCAMWIFI_RANGE_EXTENDERWELCOME_PACKcursorstringIndicates where the next page of results starts, as returned in a paginated list response
hris_profile_idstringFilter assets by assigned worker with given HRIS Profile ID
limitintegerReturn a page of results with given number of records
locationstringFilter assets by their location
WITH_USERAT_WAREHOUSEDEEL_WAREHOUSEORGANIZATION_WAREHOUSECLEARANCE_WAREHOUSESUPPLIERWITH_COURIERWRITE_OFFstatusstringFilter assets by their status
ACTIVEARCHIVEDlistItHardwarePoliciesRetrieve a list of all available IT hardware policies. These policies define the equipment that can be ordered.
listItOrdersRetrieve a paginated list of all IT equipment orders for the organization. This is useful for reviewing both historical and current procurement requests to track overall equipment provisioning.
cursorstringIndicates where the next page of results starts, as returned in a paginated list response
limitintegerReturn a page of results with given number of records
listOfContractsRetrieve a list of contracts.
after_cursorstringReturn next page of results after the given cursor.
countriesarrayFilter contracts by country codes.
currenciesarrayFilter contracts by currency codes.
expandstringInclude cost centers in the response.
cost_centersexternal_idstringFilter contracts for the given external ID.
external_id_absentstringFilter 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.
limitstringReturn a page of results with the given number of records.
order_directionstringOrder direction of results; ascending or descending.
ascdescsearchstringInclude a contract if its name or the contractor's name contains the given search term.
sort_bystringSort contracts by the given field name.
contract_titleworker_namestatusesarrayFilter contracts by current status. A contract is included in the results if its status is in this list.
team_idstringFilter contracts for the given team ID. NOTE: All query parameters are technically strings or arrays of strings.
typesarrayFilter contracts by type. A contract is included in the results if its type is in this list.
listOfEmployeeComplianceDocumentsGet a list of employee compliance documents.
listOfImmigrationCasesRetrieves 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.
case_type_idsarrayFilter by case type IDs
countriesarrayFilter by country. Uses ISO 3166-1 alpha-2 codes (https://www.iban.com/country-codes).
cursorstringPagination cursor for fetching next set of results
limitintegerMax number of results to return
searchstringSearch by applicant name or code
statusesarrayFilter by case status
listOnboardingEmployeesList all onboarding
actionsarrayOnboarding actions
contractOidarraySearch attribute to filter onboarding list by contract id
countriesarraySearch attribute to filter onboarding list by country
cursorstringCursor for pagination
fromDatestringStart date for filtering contracts
hiringTypesarraySearch attribute to filter onboarding list by hiring type
hrisDirectManagersarraySearch attribute to filter onboarding list by HRIS direct manager
include_overviewbooleanInclude an overview of the contract
legalEntitiesarraySearch attribute to filter onboarding list by legal entity
limitintegerNumber of results to return per page
progressStatusesarraySearch attribute to filter onboarding list by progress status
searchstringSearch term to filter contracts by name or other attributes
sort_bystringField to sort by
progressStatusWeightsort_orderstringSorting order
ASCDESCteamsarraySearch attribute to filter onboarding list by team
toDatestringEnd date for filtering contracts
queryAnalyticsDataExecutes 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.
dataobjectRequest 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).
retrieveAListOfAtsOffersList ATS offers for interview plan stage id
retrieveAnItAssetRetrieve the details of a specific IT asset using its unique identifier. This allows you to check information such as the asset's model, serial number, status, and location.
asset_idstringUnique identifier of the IT asset
retrieveAnItOrderRetrieve detailed information about a single IT equipment order using its unique identifier. This allows you to track the order's status, review shipping details, and see the associated product.
order_idstringUnique identifier of the IT order
retrieveAPaymentBreakdownGet a full breakdown of a payment made to Deel. Breakdown will include individual invoices and Deel fee as line items.
payment_idstringUnique identifier for the payment to retrieve the breakdown.
retrieveASingleContractRetrieve a single contract. Use for the full general contract record by contract_id. If the user specifically needs an EOR contract summary, use retrieveEorContractDetails instead.
contract_idstringUnique identifier of the contract.
expandstringInclude cost centers in the response.
cost_centersretrieveBenefitsByCountryRetrieves list of benefits available in a specific country based work visa requirement, work hours, employment type, team, and legal entity.
country_codestringCountry code.
employment_typestringType of employment
Full-timePart-timelegal_entity_idstringThe ID of the legal entity.
team_idstringThe ID of the team the worker belongs to.
work_hours_per_weeknumberWorking hours per week
work_visabooleanIndicates if work visa is required.
retrieveBenefitsForEmployeeRetrieves list of benefits for employee. This endpoint requires the employee's auth token, as the employee ID is inferred from the token.
retrieveContractAdditionalCostsForEORRetrieve all additional costs for EOR contract creation by country. Use during EOR quote preparation to understand country-specific add-on costs. Do not use it to create or retrieve a contract.
countrystringThe two-letter ISO code of the country for which to retrieve the EOR additional costs.
retrieveContractFormForEORReturn the valid fields, allowed values, validations, and country-specific requirements for creating an EOR contract for a given country. Use this before creating an EOR contract quote. Do not use it to retrieve an existing contract.
country_codestringTwo-letter country code in ISO 3166-1 alpha-2 format
contract_duration_in_daysintegerThe contract duration in days for definite contracts.
start_datestringThe selected start date of the contract in ISO 8601 formatted date string.
statestringThe selected state code of the contract. This is only required for countries that specify it.
work_hours_per_weekintegerThe selected number of work hours per week.
retrieveContractStartDateForEORReturn the earliest allowed start date for a new EOR contract quote based on employment parameters. Use during EOR quote preparation before creating the quote. Do not use it to retrieve an existing contract.
employment_countrystringEmployment country in ISO 3166-1 alpha-2 format
team_idstringTeam ID
employee_nationalitystringEmployee nationality in ISO 3166-1 alpha-2 format
employment_statestringState or province of employment
legal_entity_idstringLegal entity ID
special_job_idstringSpecial job ID (if applicable)
work_visabooleanWhether a work visa is required
retrieveCountriesRetrieve a list of countries supported by Deel, along with details about visa and EoR support, sub-territories, and their classifications.
retrieveEorContractDetailsRetrieve a summary record for an EOR contract. Use only for an existing EOR contract summary, not for non-EOR contracts or full general contract retrieval.
contract_idstringThe unique identifier for the Deel contract
retrieveJobTitlesRetrieve a list of pre-defined job titles in Deel platform.
after_cursorstringCursor for pagination. Use this to retrieve the next page of results.
retrievePaymentReceiptsRetrieve a list of payments made to Deel, including worker details, payment status, and payment methods.
currenciesarrayFilters payments by their currency codes. Can be a single currency code or an array of codes.
cursorstringA cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results.
date_fromstringFilters results to include payments created on or after this date (in ISO 8601 format).
date_tostringFilters results to include payments created before this date (in ISO 8601 format).
entitiesarrayFilters payments by legal entity type (e.g., 'individual' or 'company'). Can be a single entity type or an array.
statusesarrayFilters payments by their status (e.g., 'paid' or 'processing'). Can be a single status type or an array.
retrieveSeniorityLevelsRetrieve a list of predefined seniority levels for roles in the Deel platform, including their names, hierarchical levels, and unique identifiers.
is_eor_contractbooleanwhen `true`, exclude C-level seniorities for EOR contracts. Set to `false` to return all seniorities
retrieveSupportedCurrenciesRetrieve the list of currencies supported by Deel, including their ISO codes and names.
searchUserByEmailSearch for a user in Deel HRIS by email address and return the user details, including hrisProfileOid. Use when you have an email address and need to locate the matching HRIS profile. Do not use when you already have hris_profile_id.
countstringThe maximum number of results to return per page. Used for pagination. A value of 0 is treated as a special case and returns 1 result. Typically should be a positive integer.
filterstringFilter results using [SCIM's filtering syntax](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2). Currently supports only `eq` operator and filtering by a user's email. Expected format 'email eq "email@domain.com"'.
startIndexstringThe 1-based index of the first result to return. Used for pagination. Minimum value is 1. Defaults to 1 if not provided.
signContractSign a contract by client.
contract_idstringDeel contract id.
dataobjectupdateInvoiceAdjustmentUpdates an existing invoice adjustment by ID. This endpoint requires invoice-adjustments:write scope
dataobjectDetails of adjustment to update
idstringInvoice adjustment id.
updatePeoplePersonalInformationByExternalIdUpdate personal information by external id.
dataobjectworker_idstringUnique identifier for a worker (External ID).
updatePersonalInformationUpdate worker's personal information including names, emails, phone numbers, and date of birth.
dataobjectworker_idstringUnique identifier for a worker.
updateTimeOffRequestUpdate an existing time-off request by time_off_id. Use only when the user explicitly asks to modify an existing request. Do not use for informational questions about requests, policies, balances, or schedules.
time_off_idstringTime off request id
dataobjectTime off update request data
withdrawalTrackingInfoRetrieve the step-by-step tracking information for a withdrawal, including current progress, status steps, and any delay banners.
idintegerWithdrawal ID (numeric sequential ID or UUID v4 public ID)
profileIdstringContractor profile public ID (UUID). Required when the caller is a client/org admin. Specifies which contractor's withdrawal to look up.