Deel (Sandbox)

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. **Token scopes**: `contracts:write`

Records client approval of a project assignment for an EOR contract, confirming that the terms have been reviewed and accepted. **Token scopes**: `contracts:write`

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. **Token scopes**: `worker:write`

Employee acknowledges their assignment agreement as part of project initiation. Ensure all terms in the agreement are reviewed before acknowledgment. **Token scopes**: `worker:write`

Adds supplemental information fields to an EOR employee's contract record. **Token scopes**: `worker:write`

Registers a bank account for an EOR employee. Returns the `id` of the newly created bank account record. **Token scopes**: `worker:write`

Creates a candidate record for contractor onboarding outside of an ATS flow. The returned record can be used in subsequent contract creation calls. **Token scopes**: `candidates:write`

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. **Token scopes**: `worker:read`, `worker:write`

Sets an external identifier. Link your internal reference IDs, such as employee numbers or ERP keys, to a Deel worker. The external ID must be unique and, once set, can be used as a filter when listing contracts to directly look up Deel records from an external system. **Token scopes**: `contracts:write`

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. **Token scopes**: `people:write`

Adds supplementary fields to the contract, with the extra data supplied under the `data` object in the request body. **Token scopes**: `people:write`

Adds a note to a specific application. The `author_id` must correspond to a valid HRIS user. **Token scopes**: `ats:write`, `ats.applications.notes:write`

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. **Token scopes**: `off-cycle-payments:write`

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. **Token scopes**: `contracts:write`

Returns the most recent AML screening result for the specified entity. The `entity_type` must be one of `profile`, `hris_profile`, or `legal_entity`. **Token scopes**: `screenings:read`

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. **Token scopes**: `profile:write`

Updates the employer approval status for a pending equity exercise. This is a partial update — only `employer_approval` is accepted in the request body. **Token scopes**: `contracts:write`

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. Only time-offs currently in REQUESTED status can be reviewed; entries in any other status are returned as not reviewed. Rejecting a time-off request is irreversible: once rejected, its status cannot be changed through this API. The response distinguishes successfully processed requests from those that encountered errors. **Token scopes**: `time-off:write`

Assign cost centers to employment by contract id **Token scopes**: `contracts:write`

Associates an application with a specific interview plan stage. Set `is_current_stage` to `true` to advance the application's active stage, or `false` to record a historical stage entry without changing the current stage. Pass `applicable_job_activities` to selectively trigger activities, omit it to trigger all, or pass an empty array to trigger none; if archiving the candidate, include `candidate_archivation_reason_id` and optionally `candidate_archivation_email_template_id` to send a rejection email. **Token scopes**: `ats:write`

Attaches existing eligible entries to an On-Demand Payroll that is awaiting client review before submission. **Token scopes**: `on-demand-payroll:write`

Use this endpoint to create or update tags for candidate, job, or opening groups in bulk. Provide both tag_id and tag_name to update an existing tag label. Omit tag_id to create a new tag or match an existing one case-insensitively. **Token scopes**: `ats:write`

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.

Cancels a pending EOR contract amendment, voiding the request and preventing it from being reviewed or applied to the contract. **Token scopes**: `contracts:write`

Cancels the EOR contract identified by oid. The contract must be in an active or pending state to be eligible for cancellation. **Token scopes**: `contracts:write`

Cancels an On-Demand Payroll, optionally keeping the specified entries available for a future regular payroll cycle. **Token scopes**: `on-demand-payroll:write`

Cancels the time-off request identified by time_off_id. Use this when a previously submitted or approved time off needs to be withdrawn. This action immediately sets the request to CANCELED regardless of its current status and cannot be reversed. **Token scopes**: `time-off:write`, `worker:write`

Changes the mailbox password for an EOR worker. **Token scopes**: `worker:write`

Partially updates the auto-withdrawal configuration, allowing callers to enable or disable auto-withdrawal and change the target withdrawal method. **Token scopes**: `worker:write`

Creates a new group by copying the structure and settings of an existing group. The cloned group is independent of the source after creation. **Token scopes**: `groups:write`

Finalize an S3 multipart upload started via POST /rest/files, after all parts have been uploaded. **Token scopes**: `files:write`

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. **Token scopes**: `contracts:write`

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. **Token scopes**: `worker:read`, `worker:write`

Creates a direct employee record in Deel's HRIS, hired under the organization's own legal entity. Provisions both a person and an associated employment contract. Applicable when onboarding employees managed through your own payroll providers. It can support downstream integrations, such as IT equipment orders. **Token scopes**: `people:write`

Creates a new Global Payroll contract. Country-specific fields required in the request body vary by country and must be retrieved in advance from `GET /forms/gp/worker-additional-fields/{country_code}`. Returns the created contract including its unique `id`. **Token scopes**: `contracts:write`

Creates a new amendment for an existing EOR contract, supporting changes to terms such as salary, currency, effective date, and other contract conditions. All requests are validated against applicable business and regulatory rules before the amendment is accepted. **Token scopes**: `contracts:write`

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. **Token scopes**: `contracts:write`

Creates a new immigration case for a worker. The appropriate visa type must be determined before calling this endpoint. **Token scopes**: `immigration:write`

Creates a new organization structure within the HRIS, returning the created record including its assigned `id` and `organization_id`. The `is_multi_select` and `enable_roles` flags on the request body control whether the structure supports multiple team assignments and role management respectively. **Token scopes**: `organizations:write`

Create a new shift rate with the specified attributes such as name, type, value, and a unique external identifier. **Token scopes**: `time-tracking:write`

Creates a new task for the contractor associated with the specified contract. A task can include an amount, description, and submission date. **Token scopes**: `contracts:write`

Sets or replaces the parent relationship for the specified HRIS profile, using external identifiers. Pass null as parent_profile_external_id to remove the existing parent relationship. **Token scopes**: `profile:write`

Adds a person record in Deel's HRIS without an associated employment contract. It creates a people-only record, allowing you to track individuals in your organization's directory before or without formalizing an employment or agreement. Suitable for pre-boarding, contingent workers, or other scenarios where a contract is not yet applicable. **Token scopes**: `people:write`

Submits a new equity exercise request, associating the specified option grant and stakeholder details with a worker. The request is created in a pending state; employer approval is handled as a separate operation. **Token scopes**: `contracts:write`

Submit a new US tax form for the authenticated worker against a specific client legal entity, typically during onboarding or when a fresh form must be recorded for a worker/legal-entity pair. The worker is resolved from the access token; the target legal entity is set via client_legal_entity_id. Select the form type based on the worker's US tax status: W-9 for US individuals or entities, W-8BEN for non-US individuals, W-8BEN-E for non-US entities. The worker must have an active (non-terminated) contract with the legal entity, and only one tax form may exist per worker/legal-entity pair. **Token scopes**: `worker:write`

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. **Token scopes**: `ats:write`

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. **Token scopes**: `ats:write`

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. **Token scopes**: `profile:write`

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. **Token scopes**: `ats:write`

Issues a short-lived session token (valid 6 hours) for a child organisation. If an active session token with more than one hour of remaining validity already exists, that token is returned. Otherwise the prior session token is invalidated and a new 6-hour token is issued. Session tokens do not affect the child organisation’s original permanent token. **Token scopes**: `organizations:write`

Creates a child organization linked to the authenticated (parent) organization, provisioning a scoped API token, a default group, the parent–child hierarchy, and an initial user assignment in a single operation. The `token` in the response is the only time the child organization's API token is returned and must be stored by the caller. **Token scopes**: `organizations:write`

Replaces all child relationships of a given type for the specified HRIS profile. Any existing child relationships of that type not included in the request will be removed. **Token scopes**: `profile:write`

Generates a time-bounded consent token used to authorize third-party service connections on behalf of an organization. The token expires at the time indicated by `expires_at` in the response.

Creates an EOR worker record and returns the associated `user_id`, `profile_id`, and `hris_profile_id`. **Token scopes**: `people:write`

Submits an equity or token tax event for an EOR worker enrolled in Equity & Token Services. **Token scopes**: `equities:write`

Creates a new group within the organization and returns the created group record, including its assigned `id`. **Token scopes**: `groups:read`, `groups:write`

Creates a new hourly report preset, returning the assigned id upon success. **Token scopes**: `timesheets:write`

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. **Token scopes**: `timesheets:write`

Creates an invoicing tax entry for an independent contractor contract. **Token scopes**: `invoice-adjustments:write`

Creates a new legal entity under the organization and returns the entity record including its assigned id. **Token scopes**: `legal-entity:write`, `legal-entity:read`

Generates a time-limited magic link for password-free worker authentication. The link and its expiry timestamp are returned in the response. **Token scopes**: `worker:read`

Creates a new manager in the organization and returns the created manager's identity fields, including the assigned `id`. **Token scopes**: `organizations:write`

Creates an On-Demand Payroll for the given contract from existing eligible entries and/or a salary advance amount. **Token scopes**: `on-demand-payroll:write`

Creates a new custom role within the current organization. **Token scopes**: `organizations:write`

Creates a payment statement for the given invoices, attaches a bank transfer method for the requested country and currency, optionally applies available balance, and pays it in a single call. Returns the composed statement once payment has been initiated. **Token scopes**: `payment-statements:write`

Create raw shifts for the specified contract ID. “Raw shifts” refers to uncategorized entries—simply submit the clock-in and clock-out times. The classification of those hours (e.g., regular or overtime) will be handled by the Deel platform. **Token scopes**: `time-tracking:write`

Creates multiple time tracking shifts for a contract, supporting both regular shift submissions and corrections that adjust hours for previously processed shifts. **Token scopes**: `time-tracking:write`

Submits an approve or reject decision for a timesheet entry. Approved timesheets are queued for inclusion in the next payment cycle. **Token scopes**: `timesheets:write`

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. **Token scopes**: `treasury-vendorbill:write`

Initiates an identity verification session via Veriff, returning a URL to which the worker must be redirected to complete the verification flow. **Token scopes**: `screenings:write`, `worker:write`

Creates a new webhook subscription with the specified URL, events, and configuration. Returns the created webhook, including its signing key for verifying incoming event payloads. **Token scopes**: `webhooks:write`

Issues a scoped access token granting a worker access to worker-side API endpoints. The response includes the token value and its expiry timestamp. **Token scopes**: `admin:worker`

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. **Token scopes**: `profile:write`

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. **Token scopes**: `organizations:write`

Creates a new worker record and returns the associated user_id, profile_id, and contract_id for the created worker.

Defers the scheduled onboarding start date for the EOR employee on the specified contract. **Token scopes**: `contracts:write`

Permanently deletes an adjustment by its id. **Token scopes**: `adjustments:write`

Delete an Org Structure from the Organization. Use the force flag to bypass validation checks and remove the structure even when profiles are still assigned to it. **Token scopes**: `organizations:write`

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. **Token scopes**: `time-tracking:write`

Deletes an existing worker relationship type. **Token scopes**: `organizations:write`

Permanently removes the bank payout method identified by the given method `id`. **Token scopes**: `worker:read`, `worker:write`

Clears the value of a custom field on the specified contract, identified by the custom field `id`. **Token scopes**: `contracts:write`

Deletes a specific task from a contract. An optional `reason` can be supplied for audit or documentation purposes. **Token scopes**: `contracts:write`

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. **Token scopes**: `contracts:write`

Removes a specific custom field value from a worker record by the custom field's ID. **Token scopes**: `people:write`

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. **Token scopes**: `groups:write`

Permanently deletes an hourly report preset identified by id. **Token scopes**: `timesheets:write`

Permanently removes the specified `tax_type` from the contract's invoicing tax configuration; this action is irreversible and takes effect on future invoices. **Token scopes**: `invoice-adjustments:write`

Permanently removes an invoice adjustment by its `id`. **Token scopes**: `invoice-adjustments:write`

Archives the legal entity identified by id, marking it as inactive without permanently removing it; the response includes the archived_at timestamp. **Token scopes**: `legal-entity:read`, `legal-entity:write`

Permanently deletes a specific milestone from a contract. This operation is irreversible and removes all associated milestone data. **Token scopes**: `milestones:write`

This endpoint deletes shifts using external IDs. Once deleted, the shifts will no longer be retrievable or editable. **Token scopes**: `time-tracking:write`

Permanently removes an organization structure from the organization. **Token scopes**: `organizations:write`

Permanently deletes a shift identified by its external_id. Once deleted, the shift cannot be retrieved or modified. **Token scopes**: `time-tracking:write`

Permanently deletes a timesheet entry. An optional `reason` query parameter may be provided to record the rationale for deletion. **Token scopes**: `timesheets:write`

Permanently deletes the specified webhook subscription by its unique identifier. This action cannot be undone. **Token scopes**: `webhooks:write`

Immediately revokes the active access token for the worker identified by worker_id, terminating all API access granted by that token. **Token scopes**: `admin:worker`

Removes the worker relation identified by the given external ID. This operation removes all hierarchical associations (parent and child) linked to that relation. **Token scopes**: `profile:write`

Permanently deletes the worker relation type. **Token scopes**: `organizations:write`

Removes the worker relation. This operation removes all hierarchical associations (parent and child) linked to that profile. **Token scopes**: `profile:write`

Detaches entries from an On-Demand Payroll, keeping or removing the specified entries before the ODP is submitted. **Token scopes**: `on-demand-payroll:write`

Returns a pre-signed download URL for a specific Global Payroll (GP) employee payslip PDF. Use this after calling Retrieve employee payslips to obtain the payslipId. Requires the worker id (UUID) and the payslipId from the list response. The returned URL is temporary and should be used promptly to download the file. Supports only GP contract types. **Token scopes**: `payslips:read`, `worker:read`

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. **Token scopes**: `worker:read`

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. **Token scopes**: `worker:read`

Downloads the gross-to-net calculation report for the specified payroll report as a CSV file, with optional currency conversion applied. **Token scopes**: `global-payroll:read`

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. **Token scopes**: `contracts:read`, `worker:read`

Returns a time-limited download URL for a submitted compliance document. The URL expires at the time indicated by `expires_at` in the response. **Token scopes**: `worker:read`

Returns the progressive field requirements needed to configure a bank transfer payout method, based on the data provided in the request. The `is_final` flag in the response indicates whether all requirements have been satisfied; callers should continue submitting updated data until `is_final` is `true` before calling `POST /payouts/employees/methods`. **Token scopes**: `worker:read`, `worker:write`

Applies a partial update to an existing legal entity identified by id; only fields included in the request body are modified. **Token scopes**: `legal-entity:write`

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. **Token scopes**: `groups:read`, `groups:write`

Returns the additional information template for a given contract type and employment country, specifying the fields required to complete employee information for that combination. **Token scopes**: `contracts:read`

Submits a resignation request for an EOR contract on behalf of a team member. Callers must hold group admin or people manager permissions. **Token scopes**: `contracts:read`, `contracts:write`

Submits a termination request for an EOR contract on behalf of a team member. Callers must hold group admin or people manager permissions. **Token scopes**: `contracts:read`, `contracts:write`

Synchronizes time-off requests from an external HRIS into Deel for Global Payroll contracts only. Each record is upserted or deleted based on its external ID — records carrying `deleted: true` are removed while all others are inserted or updated — and Deel calculates the payroll cycle impact of each operation. **Token scopes**: `time-off:write`

Returns all payout methods associated with the authenticated account, with optional filtering to return only the default method. **Token scopes**: `worker:read`, `worker:write`

Fetches a single organization structure, returning associated roles and teams alongside structure metadata. **Token scopes**: `organizations:read`

Returns a specific document as a PDF for a given EOR contract. Currently only the `FRAMEWORK_AGREEMENT` document type is supported. **Token scopes**: `contracts:read`

Returns all documents associated with a specific EOR contract. **Token scopes**: `contracts:read`

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. **Token scopes**: `forms:read`

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. **Token scopes**: `contracts:read`

Retrieves all positions assigned to a given HRIS profile, including the associated role, team, and organization structure for each position. **Token scopes**: `profile:read`

Retrieves paginated, versioned form definitions for creating EOR contracts across one or more specified countries. Always use the latest effective version from the response and handle pagination; this endpoint is not intended for reading or updating existing contracts. **Token scopes**: `forms:read`

Returns the checkin questionnaire for a project assignment, including all sections and questions required for completion. The optional version parameter ensures the fetched questionnaire matches an expected version before it is rendered or submitted. **Token scopes**: `contracts:read`

Returns the earliest allowed start date for a new EOR contract quote based on the specified employment country, nationality, and visa requirements. The response also includes payroll timing parameters — `start_date_buffer`, `first_payroll_lock`, and `is_same_month_payment_country` — that govern when the contract can take effect. **Token scopes**: `contracts:read`

Retrieves all worker relationships for a given HRIS profile identified by its external identifier, including parent and child relationships. **Token scopes**: `profile:read`

Generates a single-use magic link that authenticates a manager into the platform without credentials. The target manager must belong to the requesting organization and cannot be an organization admin; this operation is restricted to White Label–enabled organizations, Partners, and Child organizations. The link expires 5 minutes after creation. **Token scopes**: `auth:write`

Accepts timesheet file metadata and returns a pre-signed `upload_url` together with a new timesheet record `id`. Currently limited to EOR contracts. **Token scopes**: `time-tracking:write`

Returns country-specific mandatory and optional questions, and identifies required supporting documents, that must be provided when initiating the offboarding process for a contract. **Token scopes**: `contracts:read`

Returns the organization's hierarchical structure, including departments and teams, with offset-based pagination. **Token scopes**: `organizations:read`

Returns all worker relations associated with the HrisProfile, including both parent and child relationships. **Token scopes**: `profile:read`

Returns all available webhook event types that can be subscribed to. Each entry includes the event name, description, and a payload example. **Token scopes**: `webhooks:read`

Returns all webhook subscriptions configured for the organization, including their current status, endpoint URLs, and subscribed events. **Token scopes**: `webhooks:read`

Returns amendment data points configuration per country. If no countries filter is provided, returns configuration for all available countries. If no configuration exists for a country, all data points are treated as enabled. **Token scopes**: `contracts:read`

Returns the validation settings for all available amendment data points on an EOR contract, optionally scoped to a specific employment state. Use these settings to determine which fields are editable and what constraints apply before constructing an amendment request. **Token scopes**: `contracts:read`

Retrieves the configured bank payout methods for an employee. **Token scopes**: `worker:read`, `worker:write`

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. **Token scopes**: `worker:read`

Returns all bank transfer routes available to the authenticated contractor. **Token scopes**: `worker:read`, `worker:write`

Returns a temporary download URL for an invoice PDF; the URL expires at the time indicated by `expires_at` in the response. **Token scopes**: `accounting:read`

Analyzes a traveller's nationality, residence country, destination, and trip dates to return the available business visa options along with their fees, estimated timelines, and qualification criteria. An optional `second_nationality` may be provided to expand eligibility assessment. **Token scopes**: `immigration:read`

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. **Token scopes**: `contracts:read`

Returns all cost centers associated with the specified legal_entity_id. **Token scopes**: `legal-entity:read`

"Retrieves a single person custom field definition by its `id`. **Token scopes**: `people:read`

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

Returns the list of departments within the authenticated user's organization, including each department's identifier, name, and parent department where applicable. **Token scopes**: `organizations:read`

Initiates or polls for async generation of an employee agreement template PDF draft. On first call (no task_id), kicks off generation and returns a task_id with is_processing: true. Poll with ?task_id=<value> until is_processing is false, at which point url contains a signed download link valid for 15 minutes. **Token scopes**: `contracts:read`

Returns the allowances and non-statutory additional costs available for inclusion in an EOR contract quote for the specified country. **Token scopes**: `contracts:read`

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. **Token scopes**: `contracts:read`

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. **Token scopes**: `contracts:read`

Returns all payslips for an EOR employee. **Token scopes**: `worker:read`

Returns termination data for the specified contract and termination record. Requires viewer permissions. **Token scopes**: `contracts:read`

Returns the bank account form guide for an EOR employee, providing the field structure required to add a new bank account. **Token scopes**: `worker:read`

Returns benefits associated with the specified EOR contract. **Token scopes**: `contracts:read`

Returns a URL for downloading the specified payslip as a PDF. **Token scopes**: `payslips:read`

Poll the status of a file registered via the upload endpoint. Call this after uploading to check whether the file has cleared virus scanning: pending means the scan is still running, ready means it can be claimed, and failed means the upload was rejected. **Token scopes**: `files:read`

Returns all bank accounts associated with the employee. **Token scopes**: `people:read`

Returns the country-specific field requirements for a worker's bank account form, which determines the fields required when adding a bank account. **Token scopes**: `people:read`

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. **Token scopes**: `groups:read`

Retrieves a single hourly report preset by its id. **Token scopes**: `timesheets:read`

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. **Token scopes**: `timesheets:read`

Retrieves a single hourly report root preset by its id, including its current status. **Token scopes**: `timesheets:read`

Returns a cursor-paginated list of hourly report root presets, with optional filtering by work_statement_statuses and result ordering. **Token scopes**: `timesheets:read`

Retrieves detailed information about a specific organizational structure including its teams and roles. **Token scopes**: `organizations:read`

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. **Token scopes**: `worker:read`

Retrieves the VAT and withholding tax settings configured for an independent contractor contract. **Token scopes**: `invoice-adjustments:read`

Retrieves the details of an immigration case by its case ID. **Token scopes**: `immigration:read`

Retrieves the OAuth consent record for the authenticated user or organization, including its current status, granted scope, and expiry.

Retrieves the details of a single invoice by `invoice_id`. **Token scopes**: `accounting:read`

This endpoint retrieves invoice information by ID. Use it to access detailed invoice data for reference or verification. **Token scopes**: `worker:read`

Returns country guides segmented by audience and contract type for the specified `country_code`. **Token scopes**: `knowledge-hub:read`

Returns reference data of the type specified by the `documents` query parameter; supported values are `currencies`, `countries`, `entity_types`, and `sic`. **Token scopes**: `legal-entity:read`

Returns a paginated list of all managers in the organization. **Token scopes**: `organizations:read`

Retrieves a single milestone identified by milestone_id within a specific contract. **Token scopes**: `milestones:read`

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

Returns the profile of the currently authenticated user, including identity, organizational membership, and integration identifiers for connected services such as Slack. **Token scopes**: `worker:read`, `people:read`

Retrieves a single off-cycle payment identified by id within a specific contract. **Token scopes**: `off-cycle-payments:read`

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. **Token scopes**: `off-cycle-payments:read`

Returns a worker's onboarding status by `hris_profile_id`. **Token scopes**: `contracts:read`, `people:read`

Returns a worker's onboarding status by `tracker_id`. **Token scopes**: `contracts:read`, `people:read`

Returns details of the organization associated with the authentication token; the organization is resolved automatically from the token and requires no additional identifier. **Token scopes**: `organizations:read`

Retrieves a payment statement by its id, including its status, amounts, beneficiary details, and the authoritative list of settled invoices. **Token scopes**: `payment-statements:read`

Returns personal information for a worker by their worker ID. **Token scopes**: `people:read`

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. **Token scopes**: `time-off:read`

Retrieves the details of a specific shift. **Token scopes**: `time-tracking:read`

Get detailed information for a specific immigration case. Use this to check case status and track process progress. The id path parameter is the case UUID returned from the 'Create Client Case' endpoint. Response is enriched with applicant profile, visa type, case status, estimated completion date, process details, and compliance document details. **Token scopes**: `worker:read`

Returns the list of teams within the authenticated user's organization, with each entry including the team's ID and name. **Token scopes**: `organizations:read`

Returns the current auto-withdrawal configuration for the authenticated worker, including whether auto-withdrawal is enabled and the identifier of the selected withdrawal method. **Token scopes**: `worker:read`

Retrieves all roles defined within the current organization. **Token scopes**: `organizations:read`

Returns a short-lived presigned URL to download a time-off attachment. The attachment_id is the id field returned in the attachments array of time-off responses. **Token scopes**: `time-off:read`

Returns time-off events for a worker profile identified by hris_profile_id, with optional filtering by time_off_type_id or policy_id. **Token scopes**: `time-off:read`

Returns a single timesheet entry. **Token scopes**: `timesheets:read`

Returns timesheets associated with the specified contract, with optional filtering by contract type, status, reporter, and date range. **Token scopes**: `timesheets:read`

Returns the KYC verification method supported for a given combination of issuing country and document type. **Token scopes**: `screenings:read`, `worker:read`

Retrieve a single webhook subscription. **Token scopes**: `webhooks:read`

Returns holidays, work schedule entries, and time-off dailies for a given date range, scoped to one or more HRIS profile IDs or countries. **Token scopes**: `time-off:read`

Retrieves the additional form fields required when onboarding EOR workers in the specified country. **Token scopes**: `forms:read`

Retrieves the signing invitation link generated for the worker on a contract, with optional localization via the `locale` parameter. **Token scopes**: `contracts:read`

Retrieves a worker profile record using a system-wide external worker identifier. **Token scopes**: `people:read`

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. **Token scopes**: `screenings:read`

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`. **Token scopes**: `payslips:read`

This endpoint provides embedded worker flows access to download a pdf of a specific invoice while using a worker:PAT token. **Token scopes**: `accounting:read`

Retrieves the details of an immigration case document by its document `id`. **Token scopes**: `immigration:read`

Returns the visa types supported for immigration processing in a country, identified by its Alpha-2 country code. **Token scopes**: `immigration:read`

Sends a signing invitation email to a worker for the specified contract, setting their email as the expected signer. If the contract was previously rejected, resets its status back to a signing-eligible state. Can only be called if the worker has not already signed the contract. **Token scopes**: `contracts:write`

Retrieves a single invoice line item by its `id`. **Token scopes**: `invoice-adjustments:read`, `worker:read`

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. **Token scopes**: `invoice-adjustments:read`

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

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. **Token scopes**: `contracts:read`

Returns the list of custom field definitions configured for contracts within the organization. The response includes field metadata, not specific contract field values. It provides definitions with contract placement for supported types such as text, list, multiselect, number, percentage, currency, and date. **Token scopes**: `contracts:read`

Lists industry subcategories with their parent category details and NAICS codes, supporting cursor-based pagination and sorting by category or subcategory name. **Token scopes**: `legal-entity:read`

Returns the list of custom field definitions configured for people within the organization. The response includes field metadata, not specific person field values. It provides definitions with people placement for supported types such as text, list, multiselect, number, percentage, currency, and date. **Token scopes**: `people:read`

Returns a paginated list of feedbacks submitted for activities on the given application, including reviewer profiles, overall recommendations, and form responses. **Token scopes**: `ats:read`, `worker:read`

Retrieves the paginated list of amendments associated with a given contract, with optional filtering by amendment status and sign status. **Token scopes**: `contracts:read`, `contracts:write`

Retrieves the standardized list of termination reasons to present when initiating a contract termination **Token scopes**: `contracts:read`

Returns the total available balances for the authenticated contractor, broken down by currency and aggregated into a single cross-currency total. **Token scopes**: `worker:read`

Returns paginated gross-to-net calculation records for the specified payroll report, with optional currency conversion applied to the results. **Token scopes**: `global-payroll:read`

Returns all HR verification letters and documents associated with the employee contract. **Token scopes**: `worker:read`

Returns a paginated list of interviews for the organization. **Token scopes**: `ats:read`

Returns invoice adjustments, optionally filtered by contract, adjustment type, status, invoice, reporter, or submission date range. **Token scopes**: `invoice-adjustments:read`

Returns a cursor-paginated list of all IT assets historically or currently managed by the organization. **Token scopes**: `it-assets:read`

Returns all available IT hardware policies, which define the equipment eligible for ordering. **Token scopes**: `it-policies:read`

Returns a cursor-paginated list of all IT equipment orders for the organization, spanning both historical and current procurement requests. **Token scopes**: `it-orders:read`

Returns a paginated list of contract summaries for the organization, with optional filtering by status, type, team, country, currency, external ID, or a name search term. Use `GET /contracts/{contract_id}` to retrieve full details for a specific contract. **Token scopes**: `contracts:read`

Returns the list of compliance documents associated with an EOR employee. **Token scopes**: `worker:read`

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. **Token scopes**: `worker:read`

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. **Token scopes**: `immigration:read`

Returns predefined and custom job scope templates available for EOR contracts, optionally filtered to templates belonging to a specific team. **Token scopes**: `organizations:read`

Returns a paginated list of legal entities in the account, with optional filtering by country, entity type, global payroll flag, and archived status. **Token scopes**: `organizations:read`, `accounting:read`

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. **Token scopes**: `people:read`

Retrieve a paginated list of shifts with details such as start and end times, breaks, metadata, and summary metrics. Supports pagination through `limit` and `offset` query parameters and filtering by `contractId`, date range (`fromDate` and `toDate`). **Token scopes**: `time-tracking:read`

Retrieves all tasks associated with a specific contract, including each task's ID, amount, submission date, status, and description. **Token scopes**: `contracts:read`

Returns tax documents for the authenticated worker. **Token scopes**: `worker:read`

Returns a paginated list of timesheets in the account, optionally filtered by contract_id, contract_types, statuses, reporter_id, or date range. **Token scopes**: `timesheets:read`

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. **Token scopes**: `worker:read`

Lists the adjustments eligible for On-Demand Payroll for the given contract, with the contract eligibility details and limits. **Token scopes**: `on-demand-payroll:read`

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. **Token scopes**: `contracts:read`, `people:read`

Returns all job openings (requisitions/headcount requests) for the authenticated organization. Supports filtering by status, team, location, and linked job. Results are cursor-paginated. Openings track headcount requests through a lifecycle from DRAFT to FILLED or CLOSED. **Token scopes**: `ats:read`

Returns a paginated list of all tasks for the current organization, not limited to those assigned to the caller; intended for callers with the `organization.manage` permission. Supports both offset/limit and cursor-based pagination, which are mutually exclusive — do not supply `cursor` together with an offset parameter. **Token scopes**: `tasks:read`

Returns a paginated list of payroll events for the specified legal entity, optionally filtered by a date range; date_start must not be earlier than 5 years ago and date_end must not exceed 5 years in the future. **Token scopes**: `legal-entity:read`

Retrieves payroll events associated with the specified legal entity, suitable for preparing payroll reports or auditing pay cycles. **Token scopes**: `global-payroll:read`

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. **Token scopes**: `time-off:read`

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. **Token scopes**: `ats:read`

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. **Token scopes**: `time-off:read`

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. **Token scopes**: `time-off:read`

Applies a partial update to the bank account details for an EOR employee. The request body accepts an array of field-level updates. **Token scopes**: `worker:write`

Partially updates the bank account for the worker; only fields provided in the request body are modified. **Token scopes**: `people:write`

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. **Token scopes**: `contracts:read`, `worker:read`

Returns the job offer letter for an EOR contract in HTML format. IC and Global Payroll contract types are not supported and will not return a result. **Token scopes**: `worker:read`

Returns a preview of the resignation letter for the EOR contract before the worker submits their signature. **Token scopes**: `worker:read`

Applies a partial update to the authenticated user's profile, modifying only the fields supplied in the request body. **Token scopes**: `profile:write`, `profile:read`

Register an upload and receive presigned S3 upload target(s) plus a file handle (file_id and one_time_secret). Use the returned upload target(s) to send the file directly, then pass the file handle to domain endpoints to claim ownership once the upload completes. **Token scopes**: `files:write`

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. **Token scopes**: `worker:write`

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. **Token scopes**: `contracts:write`

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. **Token scopes**: `global-payroll:write`

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. **Token scopes**: `worker:write`

Retrieves the country-specific additional information fields required for GP workers to run payroll in compliance with local regulations. **Token scopes**: `forms:read`

Retrieves all adjustments associated with a specific contract, optionally scoped to a date range. **Token scopes**: `adjustments:read`

Returns a paginated list of the application sources configured in the ATS. Use it to discover the valid source slugs for the `source_slugs` filter when listing applications, and to interpret the `source_slug` returned on an application. **Token scopes**: `ats:read`

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. **Token scopes**: `ats:read`

Returns a paginated list of all departments configured in the organization's ATS. Use it to resolve the department IDs accepted by the `department_ids` filter when listing jobs and by job creation, and page through results with the `cursor` and `limit` query parameters. **Token scopes**: `ats:read`

Returns a paginated list of employment types available in the organization's ATS. Use it to resolve the employment type IDs required when creating a job and accepted by the `employment_type_ids` filter when listing jobs. **Token scopes**: `ats:read`

Retrieves a list of job boards in the Applicant Tracking System **Token scopes**: `ats:read`

Returns a paginated list of job postings belonging to the specified job board. Results can be filtered using available query parameters. **Token scopes**: `ats:read`

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. **Token scopes**: `ats:read`

Returns a paginated list of all work locations associated with the organization, suitable for use when constructing job postings or filtering by location. **Token scopes**: `ats:read`

Returns all offers associated with the organization, including worker type and offer status, to support pre-onboarding and contract creation workflows. **Token scopes**: `ats:read`

Retrieves a list of all teams in the Applicant Tracking System **Token scopes**: `ats:read`

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

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. **Token scopes**: `organizations:read`

Retrieves a specific adjustment by its id, including its amount, status, payment cycle dates, and associated contract_id. **Token scopes**: `adjustments:read`

Retrieves the details of a specific IT asset by `asset_id`. **Token scopes**: `it-assets:read`

Returns the status, shipping details, and associated product for a single IT equipment order identified by order_id. **Token scopes**: `it-orders:read`

Retrieve a paginated list of shift rates, including details such as rate name, type, value, and timestamps. Pagination parameters can be used to control the size and position of the result set. **Token scopes**: `time-tracking:read`

Returns a breakdown of a payment made to Deel, with individual invoices and the Deel fee included as discrete line items. **Token scopes**: `accounting:read`

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. **Token scopes**: `worker:read`

Retrieves a shift rate. **Token scopes**: `time-tracking:read`

Retrieves the full record for a specific contract by `contract_id`, including status, compensation, worker details, and metadata. Pass `expand=cost_centers` or `expand=custom_fields` as a query parameter to include additional data in the response. **Token scopes**: `contracts:read`

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. **Token scopes**: `people:read`

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. **Token scopes**: `time-tracking:read`

Retrieves a single ATS application form by its unique ID within the specified organization. Use it when you need the full form definition and metadata, such as its title, status, and the pages, sections, and questions of the underlying form builder configuration, to display or process an application. **Token scopes**: `ats:read`

Retrieves a single application by its application_id, including associated job details, job posting details, and related metadata. **Token scopes**: `ats:read`

Returns a paginated list of hiring members configured in the ATS. **Token scopes**: `ats:read`

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. **Token scopes**: `ats:read`

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. **Token scopes**: `ats:read`

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. **Token scopes**: `worker:read`

Returns benefits available in a specific country, scoped by work visa requirement, weekly work hours, employment type, team, and legal entity. **Token scopes**: `benefits:read`

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. **Token scopes**: `benefits:read`

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. **Token scopes**: `adjustments:read`

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. **Token scopes**: `worker:read`

Fetches the scheduled payment dates and current status of each payment cycle for a specific contract. **Token scopes**: `contracts:read`

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

Retrieves the active On-Demand Payroll for the given contract, including its status, SLAs, invoice and attached entries. **Token scopes**: `on-demand-payroll:read`

Returns all custom fields associated with the specified contract. **Token scopes**: `contracts:read`