Changelog

Api Tokens → Retrieve an API token: Endpoint is now available, which allows to retrieve an API token by its identifier, without exposing its secret value.

Api Tokens → Invalidate an API token: Endpoint is now available, which allows to invalidate an API token that should no longer be used.

Api Tokens → List API tokens: Endpoint is now available, which allows to list your organization’s tokens and your own personal tokens, newest first, without their secret values.

Ats → Retrieve the ATS activity timeline: Added CANDIDATE_FOLLOW_UP_REMINDER as a valid value for category in the response and the categories query parameter, and added CANDIDATE_FOLLOW_UP_REMINDER_CREATED, CANDIDATE_FOLLOW_UP_REMINDER_UPDATED, CANDIDATE_FOLLOW_UP_REMINDER_COMPLETED, and CANDIDATE_FOLLOW_UP_REMINDER_DELETED as valid values for operation_type in the response.

Eor → Get amendment data points configuration by country: Added HOURLY_RATE as a valid value for item in the response.

Eor Amendments → Validate amendment data points: Added scope and job_title as declared fields in the request body data object.

People → Create a direct employee: Added invitation in the request that controls whether to send an invitation email to the new hire.

Onboarding → List onboarding employees: Added banners to the response (data[].overview) that lists all banners for the onboarding; added HS_OBLIGATIONS_PENDING as a valid value for overview.banner.key; added SET_UP_HEALTH_SAFETY as a valid value for overview.banner.action.

Onboarding → Get onboarding details by employee HRIS profile ID: Added banners array in the response that lists all pending banners for the worker; added HS_OBLIGATIONS_PENDING as a valid value for banner.key; added SET_UP_HEALTH_SAFETY as a valid value for banner.action.

Onboarding → Get onboarding details by onboarding tracker ID: Added banners array in the response that lists all client-action banners; added HS_OBLIGATIONS_PENDING as a valid value for banner.key and SET_UP_HEALTH_SAFETY as a valid value for banner.action.

It Assets → List IT assets: Added USED_AS_SPARE_PART as a valid value for status in the response.

Time Off → Get Policies for Organization: Added Work away from office as a valid value for policy_type in the request.

Time Off → List policies: Added Work away from office as a valid value for policy_type_name in the request.

Time Off → Get Profile Entitlements: Added Work away from office as a valid value for policy_type_name in the request.

Time Off → Process time-off requests from an external HRIS: Added Work away from office as a valid value for policy_type in the request.

Time Off → List time-off requests for Organization: Added Work away from office as a valid value for policy_type_names in the request.

Time Off → List time-off requests: Added Work away from office as a valid value for policy_type_names in the request.

Invoice Adjustments → Retrieve invoice adjustment by ID: Added new as a valid value for status in the response, and gp_client_agreement as a valid value for contract.type in the response.

Invoice Adjustments → List invoice adjustments: Added download_url to the response attachment object that provides a time-limited URL to download the attachment; added new as a valid value for status in the response and statuses query parameter; added gp_client_agreement as a valid value for contract.type in the response.

Apps → Enable an app: Endpoint is now available, which allows to enable an integration app so it can obtain tokens again.

Apps → List apps: Endpoint is now available, which allows to list the integration apps that belong to your organization.

Apps → Retrieve an app: Endpoint is now available, which allows to retrieve a single integration app that belongs to your organization.

Apps → Update an app: Endpoint is now available, which allows to update the name, description, website, or redirect URLs of an integration app.

Apps → Disable an app: Endpoint is now available, which allows to disable an integration app so it can no longer obtain tokens.

Immigration → Create an immigration case for a contract: Endpoint is now available, which allows to open an eligibility check or right to work check for the worker of a contract.

Accounting → Retrieve a payment breakdown: Added new valid values for contract_type in the response: hris_direct_contractor, office_solutions, usp_service_fee, ic_contract_fees, mobility_subscription_service_fee, intercompany, deel_card_fee, entity_management, crypto_payout, deel_ai_workforce, deel_talent_fee, deel_hris, deel_compensation, contractor_subscription_fee, integration_services_fee, bundle_commitment_fee, wallet_chargeback_recovery_funding_statement, deel_workforce_planning_fee, fee_merge, and payroll_merge.

Forms → Fetch multiple EOR Contract forms: Added CustomDropdown and PresetDropdown as valid values for type in the response.

Equity Tokens → List equity grants with tax events: Increased the maximum allowed value of limit to 200.

It Products → Retrieve a product’s catalog details: Added bundle in the response that identifies which addon type each available addon is, used to submit it in contract_setting.addons[] on POST /rest/it/orders.

It Products → Retrieve a product’s prices for a delivery country: Added bundle in the response that identifies which addon bundle each available addon belongs to, for use as bundle in contract_setting.addons[] on POST /rest/it/orders.

Ats → Retrieve suggested ATS email templates: Added DEFAULT_INTERVIEW_LOCATION_UPDATED_CANDIDATE as a valid value for type in the response.

Ats Email Templates → Retrieve a list of published ATS email templates: Added DEFAULT_INTERVIEW_LOCATION_UPDATED_CANDIDATE as a valid value for type in the request and response.

Ats → Delete an email draft to a candidate: Endpoint is now available, which allows to delete an unsent email draft addressed to a candidate.

Ats → List available slots for an interview: Endpoint is now available, which allows to list the available time slots when all interviewers of an interview are free, so a time can be proposed to the candidate before booking.

Ats → Create a stage move for an application: Endpoint is now available, which allows to advance or move back a candidate between the lead and active stages of a job’s interview plan.

Ats → List email drafts to a candidate as they would be sent: Endpoint is now available, which allows to list email drafts to a candidate as they would be sent.

Ats → Set the hiring team role of a person on a job: Endpoint is now available, which allows to add a person to a job’s hiring team, change their role, or remove them.

Ats → Create an email draft to a candidate: Endpoint is now available, which allows to save an email to a candidate as a draft without sending it, returning it rendered as it would be sent.

Ats → Set the time of an interview: Endpoint is now available, which allows to book an interview at a confirmed time or move an already booked interview to a new time.

Ats → List the private note of a job: Endpoint is now available, which allows to read the private note of a job.

Ats → Send an email draft to a candidate: Endpoint is now available, which allows to send an email draft to a candidate.

Ats → List the offer letter templates of the organization: Endpoint is now available, which allows to list the offer letter templates the organization can attach to an offer.

Ats → List the active approval options for offers: Endpoint is now available, which allows to list the approval policies or approval rules an offer can go through.

Ats → Create an offer for an application in the offer stage: Endpoint is now available, which allows to create an offer for a candidate once their application has reached the offer stage and route it to internal approval when applicable.

Ats → Validate offer terms for an application: Endpoint is now available, which allows to validate proposed offer terms against hiring rules before creating an offer.

Ats → Add content to the private note of a job: Endpoint is now available, which allows to add content to the private note of a job.

Ats → Retrieve the organization’s offer settings: Endpoint is now available, which allows to retrieve the organization’s offer settings, including whether offer approval is required and the default approval rule.

Organizations → Submit terms and conditions acceptance: Endpoint is now available, which allows to accept Deel’s terms and conditions for the organization, including legal agreements and the platform terms of service.

Organizations → Retrieve terms and conditions acceptance: Endpoint is now available, which allows to retrieve the terms and conditions acceptance status for the organization, including legal agreements and platform terms of service.

Global Payroll → Retrieve contract creation schema: Endpoint is now available, which allows to retrieve the list of fields required to create a Global Payroll contract, including field types, required status, permitted values, and validation constraints.

Organization Structure → Update an existing HRIS Org Structure: Added explicit properties id, name, children, and externalId to team items in the teams request field, defining the accepted structure for creating, updating, and deleting teams.

Invoice Adjustments → Create an invoice adjustment: Added new as a valid value for status in the response.

Immigration → Create an immigration case: Added new valid values for purpose in the travel_information request body, including EXT_BUS_MEET_NO_WORK, EXT_BUS_DELIVER_SERVICE, CONF_WORKSHOP_PAID, TECH_SUPERVISION, MARITIME_CREW, and 13 others.

Time Tracking Shifts → Get Shift details: Lowered the minimum value of time_amount to 0.

Gp Hiring → Create a Global Payroll (GP) contract: Added payroll_group_id in the request that specifies the payroll group the employee will be assigned to.

Contractor Hiring → Create contract signature: contract_template_id now accepts null.

Talent → List candidates: Endpoint is now available, which allows to list candidates submitted to Deel Talent job requests of the organization, with their pipeline status and talent partner.

Logs → List request logs: Endpoint is now available, which allows to retrieve the public API request logs made by the organization, including gateway-rejected calls, with filters for request ID, route, path, method, and status.

Logs → List token activity: Endpoint is now available, which allows to list token activity showing calls, errors, last use, and a per-day breakdown per token within the organization.

Logs → Retrieve a request log: Endpoint is now available, which allows to retrieve a single API request log by its x-request-id, including the gateway outcome explanation and troubleshooting hint.

Logs → Retrieve request logs summary: Endpoint is now available, which allows to retrieve request counts per status class, the number of rate-limited requests, p50/p95 latency, and the number of active tokens for a time window of up to 15 days.

Legal Entities → Submit KYB information for a legal entity: Added questionnaire to the response that provides the industry questionnaire template, its questions, and saved answers; and added QUESTIONNAIRE as a valid value for requirements[].category.

It Agreements → Retrieve an agreement: Added ARABIC, BELARUSIAN_JCUKEN, BRAZILIAN_PORTUGUESE_QWERTY, BULGARIAN, COLEMAK, CROATIAN_QWERTZ, DVORAK_ENGLISH, DVORAK_FRENCH, FRENCH_BEPO, GREEK, HEBREW, HUNGARIAN_QWERTZ, POLISH_QWERTY, RUSSIAN_JCUKEN, SERBIAN_CYRILLIC, SERBIAN_LATIN_QWERTZ, SLOVAK_QWERTZ, THAI, UKRAINIAN_JCUKEN, VIETNAMESE, and WORKMAN as valid values for keyboard_layout in the response.

It Agreements → List agreements: Added ARABIC, BELARUSIAN_JCUKEN, BRAZILIAN_PORTUGUESE_QWERTY, BULGARIAN, COLEMAK, CROATIAN_QWERTZ, DVORAK_ENGLISH, DVORAK_FRENCH, FRENCH_BEPO, GREEK, HEBREW, HUNGARIAN_QWERTZ, POLISH_QWERTY, RUSSIAN_JCUKEN, SERBIAN_CYRILLIC, SERBIAN_LATIN_QWERTZ, SLOVAK_QWERTZ, THAI, UKRAINIAN_JCUKEN, VIETNAMESE, and WORKMAN as valid values for keyboard_layout in the response.

It Assets → List IT assets: Added ARABIC, BELARUSIAN_JCUKEN, BRAZILIAN_PORTUGUESE_QWERTY, BULGARIAN, COLEMAK, CROATIAN_QWERTZ, DVORAK_ENGLISH, DVORAK_FRENCH, FRENCH_BEPO, GREEK, HEBREW, HUNGARIAN_QWERTZ, POLISH_QWERTY, RUSSIAN_JCUKEN, SERBIAN_CYRILLIC, SERBIAN_LATIN_QWERTZ, SLOVAK_QWERTZ, THAI, UKRAINIAN_JCUKEN, VIETNAMESE, and WORKMAN as valid values for keyboard_layout in the response and for the keyboard_layouts filter parameter.

It Agreements → Assign agreement to a new worker: Added ARABIC, BELARUSIAN_JCUKEN, BRAZILIAN_PORTUGUESE_QWERTY, BULGARIAN, COLEMAK, CROATIAN_QWERTZ, DVORAK_ENGLISH, DVORAK_FRENCH, FRENCH_BEPO, GREEK, HEBREW, HUNGARIAN_QWERTZ, POLISH_QWERTY, RUSSIAN_JCUKEN, SERBIAN_CYRILLIC, SERBIAN_LATIN_QWERTZ, SLOVAK_QWERTZ, THAI, UKRAINIAN_JCUKEN, VIETNAMESE, and WORKMAN as valid values for keyboard_layout in the response.

It Products → Retrieve a product’s catalog details: Added ARABIC, BELARUSIAN_JCUKEN, BRAZILIAN_PORTUGUESE_QWERTY, BULGARIAN, COLEMAK, CROATIAN_QWERTZ, DVORAK_ENGLISH, DVORAK_FRENCH, FRENCH_BEPO, GREEK, HEBREW, HUNGARIAN_QWERTZ, POLISH_QWERTY, RUSSIAN_JCUKEN, SERBIAN_CYRILLIC, SERBIAN_LATIN_QWERTZ, SLOVAK_QWERTZ, THAI, UKRAINIAN_JCUKEN, VIETNAMESE, and WORKMAN as valid values for keyboard_layout in the response.

It Products → List products in the catalog: Added ARABIC, BELARUSIAN_JCUKEN, BRAZILIAN_PORTUGUESE_QWERTY, BULGARIAN, COLEMAK, CROATIAN_QWERTZ, DVORAK_ENGLISH, DVORAK_FRENCH, FRENCH_BEPO, GREEK, HEBREW, HUNGARIAN_QWERTZ, POLISH_QWERTY, RUSSIAN_JCUKEN, SERBIAN_CYRILLIC, SERBIAN_LATIN_QWERTZ, SLOVAK_QWERTZ, THAI, UKRAINIAN_JCUKEN, VIETNAMESE, and WORKMAN as valid values for keyboard_layouts in the request.

Webhooks → Send a simulated webhook event: Endpoint is now available, which allows to send a simulated event payload to a webhook subscription to test it without waiting for a real event.

Ats → Retrieve ATS email template tokens: Endpoint is now available, which allows to list the placeholder tokens that ATS email templates can contain.

Ats → Retrieve suggested ATS email templates: Endpoint is now available, which allows to retrieve suggested ATS email templates for the authenticated user, including frequently used templates and stage-specific suggestions.

Ats → Retrieve current application counts per interview plan stage: Endpoint is now available, which allows to retrieve current application counts per interview plan stage.

Ats → Retrieve average time per interview plan stage: Endpoint is now available, which allows to retrieve the average time applications spent in each interview plan stage across selected jobs.

Ats → Retrieve ATS job: Endpoint is now available, which allows to retrieve a single ATS job by its ID, including its current status, closure reason, approval request, and interview plan stages.

Ats → Generate a preview of an ATS email template: Endpoint is now available, which allows to render a published email template for one application, filling its placeholders with the candidate’s, job’s and sender’s data, and report any placeholder that could not be filled.

Ats → Retrieve ATS offer: Endpoint is now available, which allows to retrieve a single ATS offer by ID, including its status, approval request, and associated application.

Ats → Retrieve the ATS activity timeline: Endpoint is now available, which allows to retrieve the history of changes made to candidates, applications, and jobs, including who changed what and when.

It Products → Retrieve a product’s prices for a delivery country: Endpoint is now available, which allows to retrieve a product’s prices for a delivery country.

People → List worker addresses: Endpoint is now available, which allows to retrieve a worker’s current home, postal, and contract addresses, with optional support for future-dated (scheduled) versions.

People → Update worker address by type: Endpoint is now available, which allows to partially update a worker’s home or postal address by type.

Talent → List job requests: Endpoint is now available, which allows to retrieve a cursor-paginated list of Deel Talent job requests for the organization.

Payments → Retrieve a payment statement: Added email, network, deposit_uri, and deposit_address to beneficiary_details in the response; payment_currency and beneficiary_details.currency now accept USDC and USDT in addition to three-letter ISO 4217 codes.

Payments → Create and pay a payment statement: Added optional method and network fields to the request payment object to support STABLECOIN_TRANSFER payments in USDC or USDT; added email, network, deposit_uri, and deposit_address to beneficiary_details in the response; payment_currency and beneficiary_details.currency now accept USDC and USDT in addition to three-letter ISO 4217 codes.

Webhooks → List webhooks: Added optional limit, cursor, status, hidden, search, _order, and include query parameters for pagination and filtering; added cursor to the response for next-page navigation; added optional stats field to each webhook item in the response with delivery health metrics.

Ats Applications → Retrieve a list of ATS applications: Added optional job_ids, hiring_member_hou_ids, and hiring_member_role_ids query parameters to filter applications by a set of job IDs, by HRIS organization users on a job’s hiring team, and by those members’ roles respectively.

Ats Applications → Assign application to interview plan stage: Added optional expected_current_interview_plan_stage_id in the request body that acts as a precondition; if the application’s current stage does not match, nothing changes and a 409 is returned.

Ats → Update ATS Candidate: Added expected_updated_at in the request that serves as an optimistic-locking precondition: if the candidate has been modified since the value was last read, nothing is updated and a 409 is returned.

Ats → Update ATS Application: Added expected_updated_at in the request body that serves as an optional precondition; if the application has been updated since the supplied timestamp, nothing is changed and a 409 precondition_failed is returned.

Ats Candidates → Set the tags of a candidate: Added optional expected_tag_ids in the request body that serves as a precondition; if the candidate’s current tags do not match, nothing is replaced and a 409 is returned.

Ats Candidates → Retrieve paginated list of ATS Candidates: Added city and country_code to the response; added source_slugs, team_ids, and locations as optional query parameters.

Ats Hiring Members → Retrieve ATS hiring members: Added job_id, role_id, and role_name to each member in the response; added optional job_id query parameter to filter results to a specific job’s hiring team.

Ats Offers → Retrieve a list of ATS offers: Added is_required in the response that indicates whether the custom field is required.

Ats Email Templates → Retrieve a list of published ATS email templates: Added body, subject, and type fields to the response; added optional type query parameter to filter results by template type.

Ats Jobs → Retrieve a list of ATS jobs: Added opened_at, closed_at, and active_pause_period to the response; added optional opened_after, opened_before, closed_after, closed_before, and hiring_member_hou_ids query parameters.

Ats → List job openings: Added filled_at, opened_at, and recruiter_hris_organization_user_id to the response; added optional recruiter_hris_organization_user_ids and created_by_hris_organization_user_ids query parameters.

It Assets → List IT assets: Added keyboard_layout and operating_system to the response; added optional keyboard_layouts, operating_systems, and search query parameters for filtering by keyboard layout, operating system, and searching by product name or brand.

Workers → Retrieve one compliance document of a worker contract: Added review in the response that provides the Deel review outcome for the submission, including status and rejection_message.

Eor Hiring → Retrieve detailed hiring guide for a country: Added optional include_usd_values query parameter and response fields salary.min_usd and salary.max_usd that return the salary range converted to USD at the mid-market exchange rate.

Workers → List compliance documents of a worker contract: Added review in the response that provides the outcome of the Deel review of the submission.

Legal Entities → Retrieve the KYB state of a legal entity: Added questionnaire in the response that exposes the applicable industry questionnaire (template, questions, and saved answers). Added QUESTIONNAIRE as a valid value for category in requirements in the response.

Legal Entities → Upload a KYB document for a legal entity: Added QUESTIONNAIRE_DOCUMENT as a valid value for document_type in the request and response.

Legal Entities → Submit EDD request answers for a legal entity: Added questionnaire to the response containing the industry questionnaire that applies to the legal entity; added QUESTIONNAIRE as a valid value for requirements[].category in the response.

Contractor Hiring → Retrieve contractor payment dates: Added awaiting_invoice_submission and completed as valid values for status in the response.

Tasks → Create a new task: Added optional group_key and hourly_report_preset_id request fields; added new as a valid value for status in the response.

Contracts → List of contracts: Added employment_details in the response that provides employment-related details for the contract, including non-compete and non-solicitation clause states.

On Demand Payroll → Retrieve current On-Demand Payroll: Added id to each entry in the response that identifies the On-Demand Payroll entry; added source_service_entry_id in metadata that provides the public ID of the entry in the originating service.

On Demand Payroll → Create On-Demand Payroll: Added id to each entry in the response that identifies the On-Demand Payroll entry; added source_service_entry_id to entry metadata that provides the public ID of the entry in the originating service.

Accounting → Get invoice by id: Added contract_id in the response that provides the unique identifier of the related contract.

Ats Applications → Retrieve ATS application: Added source_channel_name, source_channel_medium_slug, and source_channel_campaign_slug to the response, providing the source channel name, placement medium, and hiring campaign for the application’s traffic source.

Ats Applications → Retrieve a list of ATS applications: Added source_channel_name, source_channel_medium_slug, and source_channel_campaign_slug to the response, providing the source channel name, placement kind, and hiring campaign for the application’s referral source.

Eor Contract → Retrieve EOR Contract Details: Added work_arrangement_type field to the response, extended payroll_type enum with BIWEEKLY, WEEKLY, FOUR_WEEKLY, and QUARTERLY values, and added COMPLIANCE_RESTRICTIONS to the rejection_reason enum.

Forms → Fetch multiple EOR Contract forms: Added Nested as a new supported value for the type field in form questions.