Changelog

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.

Ats → Get an interview transcript: Endpoint is now available, which allows to retrieve the transcript of an interview as a paginated, ordered list of speaker segments.

Legal Entities → Submit EDD request answers for a legal entity: Endpoint is now available, which allows to answer the open enhanced due diligence (EDD) request of a legal entity by submitting answers for each question in the EDD form.

It Products → List products in the catalog: Added category query parameter that filters results by product category.

Ats Applications → Retrieve a list of ATS applications: Added position_number to the current_application_interview_plan_stage.interview_plan_stage response field that indicates the ordinal position of the stage in the job pipeline; raised the limit query parameter maximum from 100 to 500.

Ats Offers → Retrieve a list of ATS offers: Added application object and sent_at field to the response that identify the offer’s candidate and job without a second lookup and record when the offer was sent to the candidate.

Webhooks → Retrieve a single webhook: Added include_child_orgs to the response that indicates whether the webhook will also receive events from child organizations.

Ats Jobs → Retrieve a list of ATS jobs: Added optional job_ids query parameter that allows resolving specific jobs by UUID, and added PAUSED as a new allowed value to the status filter parameter and response field.

Webhooks → Update a webhook: Added url, name, events, and description fields to the request body, allowing callers to update additional webhook subscription properties.

Eor → Get amendment data points configuration by country: Added new allowed values to the item enum in the response: END_DATE, CURRENCY, TIME_OFF_TYPE, FIXED_ALLOWANCES, PROBATION_PERIOD, SENIORITY_ID, WORK_HOURS_PER_WEEK, EMPLOYMENT_STATE, EMPLOYMENT_TYPE, EMPLOYEE_NATIONALITY, NOTICE_PERIOD_DURING_PROBATION, NOTICE_PERIOD_AFTER_PROBATION, NOTICE_PERIOD_TYPE, WORK_SCHEDULE, SENIORITY_DATE, JOB_CATEGORY, and JOB_CODE.

Custom Fields Contracts → List all custom fields: Added hyperlink as a new allowed value for the type.name field in the response, enabling custom fields of hyperlink type.

Custom Fields Contracts → Get custom fields from contracts: Added hyperlink as a new allowed value for the type.name field in the response, enabling custom fields of hyperlink type.

Custom Fields Contracts → Retrieve custom fields for a contract: Added hyperlink as a new allowed value for the type field in the response.

Custom Fields People → List all people custom fields: Added hyperlink as a new allowed value for the type.name field and peo, hris_direct_contractor, and person_without_contract as new allowed values for the settings.worker_types field in the response.

Custom Fields People → Retrieve custom fields for a worker: Added hyperlink as a new allowed value for the type field in the response.

Legal Entities → Submit KYB information for a legal entity: Added null as an explicit allowed value for meta_type in the response documents array, documenting that it is null for non-Proof of Authority documents.

Legal Entities → Retrieve the KYB state of a legal entity: Added null as an explicit allowed value in the meta_type enum of documents response items, reflecting that this field is null for non-Proof of Authority documents.

Adjustments → Retrieve adjustments: Added odp_only to the response that indicates whether the adjustment is restricted to on-demand payroll and never attached to a regular payroll cycle.

People → Create a person without a contract: Added address field to the request body that allows specifying the home address of the person being hired.

Immigration → Get case timeline: Added AGENT_ADD_RFE_DEADLINE as a new allowed value for the type field of actions.

Legal Entities → Upload a document for an EDD request of a legal entity: Endpoint is now available, which allows to upload a document for a DOCUMENT_UPLOAD question of an open EDD request and obtain an opaque handle to reference in an EDD answer.

Legal Entities → Submit KYB information for a legal entity: Endpoint is now available, which allows to submit Know Your Business (KYB) verification information, company documents, and declared persons of significant control for a legal entity.

Immigration → Get case timeline: Endpoint is now available, which allows to retrieve the processes, steps and client or employee actions of a case.

Immigration → List case visa application quotes: Endpoint is now available, which allows to retrieve the visa application quote Deel proposed on an eligibility check case, with all its fees.

Immigration → List case invoices: Endpoint is now available, which allows to retrieve the invoices issued to the organization for a case, including payment status, amount, currency, and due date.

Immigration → Approve a visa application quote: Endpoint is now available, which allows to approve a visa application quote for an eligibility check case.

Ats → List interviews: Added SLOT_REQUEST_SENT and SLOTS_SUBMITTED to the status_enum response field and status filter parameter allowed values.

Legal Entities → Retrieve the KYB state of a legal entity: Added edd to the response that provides the open enhanced due diligence (EDD) request, including its status and questions, while the entity is under EDD review.

Eor → Reject an EOR quote: Added COMPLIANCE_RESTRICTIONS to the allowed values of reason in the request body.

Accounting → Get invoice by id: Added adjustment_id and pricing_fx_rate fields to line_items in the response.

Time Off → List time-off requests for Organization: Added AUTO_BANK_HOLIDAY to the allowed values of time_off_origin in the response, representing a bank holiday request that the system books for the worker.

Time Tracking Shifts → List of shifts: Changed time_amount minimum validation in the response from exclusive (must be greater than 0) to inclusive (value of 0 is now allowed).

Time Tracking Shifts → Create shifts: Changed time_amount and total_payable_hours minimum validation in the correction shift summary from exclusive (must be greater than 0) to inclusive (value of 0 is now allowed), enabling correction shifts to fully zero out the hours of the original shift.

Payouts → Update a bank transfer method: Added version in the response that provides the version identifier for the bank transfer method.

Global Payroll → Create a Global Payroll worker: Endpoint is now available, which allows to create a Global Payroll worker and their contract in a single call.

Global Payroll → Retrieve the Global Payroll worker creation schema: Endpoint is now available, which allows to retrieve the fields accepted by the Global Payroll worker creation endpoint, including required status, permitted values, and validation rules.

Organizations → Add admins to child organizations: Endpoint is now available, which allows to add multiple admins to child organizations in one call.

Global Payroll → Get payroll activation readiness for a legal entity: Endpoint is now available, which allows to check whether a legal entity has reached payroll activation readiness.

Global Payroll → Update end date for a contract: Endpoint is now available, which allows to update the end date of a Global Payroll contract, making it fixed-term when an end date is set or open-ended when null, effective from a specified date.

Ats Applications → Retrieve ATS application: Added EXPIRED to the offer_status_enum response field that indicates an offer has expired.

Eor Contract → Create an EOR contract: Added job_code and job_category to the response that provide the country-specific occupation code and the job category assigned to the role.

Legal Entities → List of legal entities: Added status field to each item in the response that provides the mapped legal entity lifecycle status.

People → Retrieve a single person: Added person_status and lifecycle_status to the response that provide the person profile status and work lifecycle stage respectively; also added middle_name and other new response fields.

Organizations → Create child organization: Added optional parent_admin_emails and child_admins arrays to the request, allowing callers to specify parent organization admins and child organization admins when creating a child organization.

Onboarding → Get onboarding details by employee HRIS profile ID: Added banner, actions, contracts, and app_experience fields to the response, and expanded profile, stepper, contract, progress, checklist, and hris_profile with additional sub-fields.

Onboarding → Get onboarding details by onboarding tracker ID: Added banner, actions, contracts, and app_experience to the response, and extended profile, stepper, contract, progress, checklist, and hris_profile with additional sub-fields.

Onboarding → List onboarding employees: Added lifecycleStatuses, waitingOnParties, card, weekFromDate, and weekToDate query parameters for filtering; added profile, overview, contracts, pending_steps, invitation_sent, and can_send_invitation to each response item; and expanded contract, progress, hris_profile, and app_experience with additional sub-fields.

Eor Offboarding → Retrieve Offboarding Request: Added new values to the reason field in the request_data response, including WORKER_TYPE_CHANGE, DISSATISFIED_WITH_DEEL_SERVICE, DISSATISFIED_WITH_DEEL_PRICING, DISSATISFIED_WITH_DEEL_PRODUCT, DEEL_COLLECTIONS, and additional employee departure reason codes.

Time Off → Create time-off request: Added custom_field_values to the request and response that allows submitting and retrieving answers to custom fields declared by the time-off policy.

Time Off → Validate time-off request: Added custom_field_values to the request and custom_fields and custom_field_validation_results to the response to support submitting and validating custom field answers declared by the time-off policy.

Time Off → List time-off requests for Organization: Added Bereaved partner's paternity leave, Carer's leave, Neonatal care leave, Parental bereavement leave, and Shared parental leave as accepted values for the policy_type_names filter parameter.

Time Off → List policies: Added has_custom_fields, is_requiring_custom_fields, and custom_fields to the response, and expanded the policy_type_name query parameter with additional allowed values.

Time Off → Process time-off requests from an external HRIS: Added new accepted values to policy_type in the request: Bereaved partner's paternity leave, Carer's leave, Neonatal care leave, Parental bereavement leave, Shared parental leave, and Work Location.

Time Off → Get Profile Entitlements: Added five new values to the policy_type_name filter: Bereaved partner's paternity leave, Carer's leave, Neonatal care leave, Parental bereavement leave, and Shared parental leave.

Time Off → List time-off requests: Added Bereaved partner's paternity leave, Carer's leave, Neonatal care leave, Parental bereavement leave, and Shared parental leave as accepted values for the policy_type_names filter parameter.

Time Off → Get Policies for Organization: Added five UK family leave types to the policy_type filter: Bereaved partner's paternity leave, Carer's leave, Neonatal care leave, Parental bereavement leave, and Shared parental leave.

Ats Locations → Retrieve a list of ATS locations: Added include_archived query parameter to include archived locations in the response, and added archived_at response field indicating when a location was archived.

Ats Tags → List tags: Added include_archived query parameter to include archived tags in the response, and added archived_at field to the response that indicates when a tag was archived.

Ats Departments → Retrieve a list of ATS departments: Added include_archived query parameter to include archived departments in the response, and added archived_at response field indicating when a department was archived.

Ats Reasons → Retrieve paginated list of ATS Rejection/Archivation reasons: Added include_archived query parameter to include archived reasons in the response, and added archived_at response field indicating when a reason was archived.

Ats → Retrieve a list of ATS teams: Added include_archived query parameter to include archived teams in the response, and added archived_at response field indicating when a team was archived.

Users → List users: Added jobProfile field in the response that provides the worker’s active job profile from job architecture, and departmentCustomFields field that provides org-structure custom fields for the department node.

Users → Retrieve a single User: Added jobProfile field in the response that provides the worker’s active job profile from job architecture, and departmentCustomFields field that provides org-structure custom fields for the department node.

Payments → Create and pay a payment statement: Added new fields to beneficiary_details in the response (address, bsb_code, bank_code, ifsc_code, branch_code, account_type, bank_address, routing_number, intermediary_bank, ach_routing_number, wire_routing_number) that provide additional bank routing details for various payment rails.

Payments → Retrieve a payment statement: Added new fields to beneficiary_details in the response, including address, bsb_code, bank_code, ifsc_code, branch_code, account_type, bank_address, routing_number, ach_routing_number, wire_routing_number, and intermediary_bank.