Deel

Deel is a global HR platform for hiring, payroll, and compliance across employer-of-record (EOR), independent-contractor, global-payroll, and contractor-of-record workforces. Its REST API exposes contracts, workers, invoices, payslips, timesheets, and organization data so you can integrate global payroll and workforce records into your data pipelines.

Power end-to-end data operations for your Deel API with Nexla. Our bi-directional Deel connector is purpose-built for Deel, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Deel or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Deel workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Deel credential, you need to generate a Deel API token from the Developer Center in your Deel dashboard. Deel authenticates API requests with a Bearer token sent in the Authorization header.

To obtain your Deel API token, follow these steps:

1. Sign in to your Deel dashboard as an organization administrator.

2. Navigate to Apps & Integrations > Developer Center.

3. Select the Organization tokens tab. Organization tokens are tied to the whole organization and can access resources without being linked to an individual user profile. Alternatively, use the Personal tokens tab to create a token tied to your own user.

4. Click Generate New Token.

5. In the dialog, enter a name for the token (for example, "Nexla Integration") and select the scopes the token requires. Grant only the minimum scopes needed for your use case.

6. Click to generate the token, then copy it immediately and store it securely. The token is shown only once and cannot be retrieved again after you leave the screen.

The token is sent as Authorization: Bearer <your-token> on every request to the Deel API. Treat the token as sensitive information. If it is ever compromised, revoke it in the Developer Center and generate a new one. For more detail, see the Deel Developer Platform documentation and the Deel API reference.

Authenticate

Authenticate to the Deel API using a Bearer API token generated from Developer Center > API Keys in the Deel dashboard.

Credentials required

Field	Required	Secret	Description
API Key	Yes	Yes	Deel API token (personal or organization), sent as a Bearer token. Generate one under Developer Center > API Keys in the Deel dashboard.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Deel API token in the API Key field. This is the Bearer token you generated in Prerequisites, and it is sent in the Authorization header on all requests to the Deel API.

   If your API token is compromised, revoke it in the Deel Developer Center and generate a new one. Organization tokens can access all resources in the organization without expiring, so keep them confidential.

   For more information about token creation, scopes, and authentication, see the Deel Developer Platform documentation.

4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Deel connector tile, then select the credential that will be used to connect to Deel, and click Next; or, create a new Deel credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Deel endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Contracts

List all contracts (EOR, IC, GP, COR) visible to the API token, cursor-paginated.

[Rest API] Get Contract

Get details of a single contract.

[Rest API] List Workers

List people/workers in the organization.

[Rest API] Get Worker Personal Info

Get personal information for a single worker.

[Rest API] List Invoices

List invoices, cursor-paginated, filterable by issue date and status.

[Rest API] Get Invoice

Get details of a single invoice.

[Rest API] List Invoice Adjustments

List invoice line-item adjustments (bonuses, deductions, expenses).

[Rest API] List EOR Worker Payslips

List payslip records for an Employer-of-Record worker.

[Rest API] List Global Payroll Worker Payslips

List payslip records for a Global Payroll worker.

[Rest API] List Timesheets

List timesheet entries, filterable by contract, status, and date range.

[Rest API] Get Timesheet

Get a single timesheet entry.

[Rest API] List Timesheets By Contract

List timesheet entries for a specific contract.

[Rest API] Get Organization

Get details of the current organization.

[Rest API] List Off-Cycle Payments

List off-cycle (ad hoc) payments for a contract.

[Rest API] List Contract Amendments

List amendments made to a contract.

[Rest API] List Groups

List organization groups, cursor-paginated.

[Rest API] List Legal Entities

List legal entities under the organization.

[Rest API] List Contract Milestones

List milestones defined on a milestone-based contract.

[Rest API] List Countries

List supported countries with visa/EOR eligibility data.

[Rest API] List Webhooks

List configured webhook subscriptions.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Deel data sources can also be manually configured to ingest data from any valid Deel API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Deel data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Deel destination, and select the Send to Destination option from the menu. Select the Deel connector from the list of available destination connectors, then select the credential that will be used to connect to Deel, and click Next; or, create a new Deel credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Deel endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Contract

Create a new contract (EOR, IC, GP, or COR).

[Rest API] Create Timesheet Entry

Submit a new timesheet entry for an hourly contract.

[Rest API] Create Off-Cycle Payment

Add an off-cycle (ad hoc) payment to a contract.

[Rest API] Create Invoice Adjustment

Create a new invoice line-item adjustment (bonus, deduction, expense).

[Rest API] Terminate Contract

Request termination of an existing contract.

[Rest API] Create Webhook

Register a new webhook subscription.

Manual configuration

Deel destinations can also be manually configured to send data to any valid Deel API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Deel APIs typically expect JSON format for write operations. For update operations, include the ID of the object to be updated as a path parameter at the end of the endpoint URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Deel endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Deel endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.