Deel API Directory

Deel is a cutting-edge software platform designed to streamline payroll, HR management, and Employer of Record (EOR) solutions for businesses looking to expand their global workforce. By enabling companies to hire and pay employees in over 150 countries, Deel addresses the complexities of international compliance, taxes, and local labor laws. This makes it an invaluable tool for organizations aiming to manage their global workforce efficiently and effectively.

One of the standout features of Deel is its robust API integration capabilities, which allow businesses to seamlessly connect Deel's functionalities with their existing systems. The Deel API facilitates smooth data exchange and process automation, enhancing the overall efficiency of global HR operations. As companies increasingly seek to leverage technology for workforce management, understanding the Deel API integration process becomes crucial for optimizing their international hiring strategies.

Key highlights of Deel APIs

Comprehensive Resource Management: The API provides access to various resources, including Contracts, Tasks, Timesheets, Milestones, Off-cycle Payments, Invoice Adjustments, Organizations, Legal Entities, Lookups, and Groups. Deel
Authentication: Utilizes token-based authentication, supporting both personal and organization tokens. Personal tokens are linked to individual users and inherit their permissions, while organization tokens are associated with service users, offering broader access without expiration. Deel
Sandbox Environment: Deel provides a sandbox environment with sample data, enabling developers to test API integrations thoroughly before deploying them in a production setting.

Deel API Endpoints

Adjustments

POST https://api.letsdeel.com/rest/v2/adjustments : This API endpoint allows the creation of a new adjustment.
GET https://api.letsdeel.com/rest/v2/adjustments/categories : This API endpoint retrieves all adjustment categories for your organization.
DELETE https://api.letsdeel.com/rest/v2/adjustments/{adjustment_id} : The Delete Adjustment API allows users to delete an existing adjustment by specifying the adjustment_id in the path parameters.

Candidates

POST https://api.letsdeel.com/rest/v2/candidates : This API endpoint allows you to add a candidate to Deel.
PATCH https://api.letsdeel.com/rest/v2/candidates/{candidate_id} : The Update Candidate API allows you to update the details of an existing candidate using their candidate ID.

Contract Templates

GET https://api.letsdeel.com/rest/v2/contract-templates : This API endpoint retrieves a list of contract templates available in your organization.

Contracts

GET https://api.letsdeel.com/rest/v2/contracts : This API endpoint retrieves a list of contracts from the Deel platform.
GET https://api.letsdeel.com/rest/v2/contracts/custom_fields : This API endpoint fetches all custom fields associated with contracts, providing additional data necessary for contract management.
GET https://api.letsdeel.com/rest/v2/contracts/custom_fields/{field_id} : This API endpoint allows users to access details of a specific custom field associated with a contract.
POST https://api.letsdeel.com/rest/v2/contracts/gp : This API endpoint allows the creation of a Global Payroll contract.
PATCH https://api.letsdeel.com/rest/v2/contracts/{contract_id} : This API endpoint allows you to add an external ID to a Deel contract.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/adjustments : This API endpoint retrieves all adjustments for a specific contract identified by the 'contract_id' path parameter.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/amendments : This API endpoint allows you to amend the details of a contract.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/custom_fields : This API endpoint retrieves all custom field values for a specific contract, allowing for enhanced contract management with detailed, custom-configured data.
DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/custom_fields/{field_id} : This API endpoint allows the deletion of a specific custom field's value from a contract.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/documents : This API endpoint allows users to attach a file to a contract document in the Deel system.
DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/invitations : The Remove Contract Invitation API allows you to delete an invitation for a worker to sign a contract.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/invoice-adjustments : This API endpoint retrieves invoice line items for a specified contract ID.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones : This API endpoint allows you to add a new milestone to a specified contract in the Deel system.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones/many/reviews : This API endpoint allows users to review a batch of milestones by approving or rejecting submitted work.
DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones/{milestone_id} : This API endpoint allows the user to delete a specific milestone from a contract using the DELETE method.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones/{milestone_id}/reviews : This API endpoint allows users to review a milestone by approving or declining the submitted work.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/off-cycle-payments : This API endpoint retrieves a list of off-cycle payments for a specified contract ID.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/off-cycle-payments/{offcycle_payment_id} : This API endpoint retrieves a single off-cycle payment for a specified contract.
DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/premium : This API endpoint is used to remove Deel Premium from an existing contract.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/preview : This API endpoint retrieves the content of an IC and EOR contract agreement in HTML format.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/signatures : This API endpoint allows a client to sign a contract on the Deel platform.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks : This API endpoint retrieves a list of tasks associated with a specific contract identified by the 'contract_id' path parameter.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks/many/reviews : This API endpoint allows users to review multiple tasks associated with a specific contract by either approving or declining the submitted work.
DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks/{task_id} : This API endpoint allows the user to delete a specific task from a contract in the Deel system.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks/{task_id}/reviews : This API endpoint allows users to review a single task to either approve or decline the submitted work.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/terminations : This API endpoint is used to terminate an active contract on the Deel platform.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/timesheets : This API endpoint retrieves a list of timesheets associated with a specific contract.

Departments

GET https://api.letsdeel.com/rest/v2/departments : This API endpoint retrieves a list of departments within an organization.

EOR

POST https://api.letsdeel.com/rest/v2/eor : This API endpoint is used to create an Employee of Record (EOR) contract quote.
POST https://api.letsdeel.com/rest/v2/eor/employment_cost : This API endpoint is used to determine the Employer of Record (EOR) employee costs across the globe.
GET https://api.letsdeel.com/rest/v2/eor/validations/{country_code} : The 'Retrieve Hiring Guide Data for a Country' API endpoint allows users to obtain detailed hiring guide data for a specified country.
GET https://api.letsdeel.com/rest/v2/eor/workers/{worker_id}/payslips/{payslip_id}/download : This API endpoint allows users to retrieve the download URL for an EOR (Employer of Record) payslip.
GET https://api.letsdeel.com/rest/v2/eor/{contract_id}/benefits : This API endpoint retrieves the benefits associated with a specific EOR (Employer of Record) contract.

Global Payroll

GET https://api.letsdeel.com/rest/v2/gp/legal-entities/{legal_entity_id}/reports : This API endpoint retrieves a list of global payroll events associated with a specific legal entity.
GET https://api.letsdeel.com/rest/v2/gp/reports/{gp_report_id}/gross_to_net : This API endpoint retrieves a list of global payroll reports detailing gross-to-net calculations for a specified report ID.
GET https://api.letsdeel.com/rest/v2/gp/reports/{gp_report_id}/gross_to_net/csv : This API endpoint allows users to download global payroll reports detailing gross-to-net calculations in CSV format.
PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/address : This API endpoint allows updating the address of a Global Payroll employee.
GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/banks : This API endpoint retrieves all bank accounts associated with a specific employee identified by the 'worker_id' path parameter.
GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/banks/guide : This API endpoint retrieves the bank form guide for a specific employee identified by the worker_id.
PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/banks/{bank_id} : This API endpoint allows modification of a bank account for an employee.
PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/compensation : This API endpoint allows updating the compensation of a Global Payroll employee.
PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/employee-information : This API endpoint allows updating the Global Payroll employee information for a specific worker identified by the 'worker_id' path parameter.
GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/payslips : This API endpoint retrieves the payslips for a specific employee identified by the worker_id.
GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/payslips/{payslip_id}/download : This API endpoint allows you to get the download URL for a GP payslip.
PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/pto-policy : This API endpoint allows updating the PTO (Paid Time Off) policy of a Global Payroll employee.
POST https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/terminations : This API endpoint is used to request a termination for a global payroll employee.

Invoice Adjustments

POST https://api.letsdeel.com/rest/v2/invoice-adjustments : This API endpoint allows you to create an invoice adjustment on Deel.
POST https://api.letsdeel.com/rest/v2/invoice-adjustments/many/reviews : This API endpoint allows users to review multiple invoice adjustments by approving or declining a batch.
DELETE https://api.letsdeel.com/rest/v2/invoice-adjustments/{invoice_adjustment_id} : The Delete Invoice Adjustment API allows users to delete an existing invoice adjustment by specifying the invoice_adjustment_id in the path parameters.
POST https://api.letsdeel.com/rest/v2/invoice-adjustments/{invoice_adjustment_id}/reviews : This API endpoint allows users to review an invoice adjustment by either approving or declining it.

Invoices

GET https://api.letsdeel.com/rest/v2/invoices : This API endpoint retrieves a list of paid invoices for your workforce.
GET https://api.letsdeel.com/rest/v2/invoices/deel : This API endpoint retrieves a list of invoices related to Deel fees.

Legal Entities

GET https://api.letsdeel.com/rest/v2/legal-entities : This API endpoint retrieves a list of legal entities associated with your account.

Lookups

GET https://api.letsdeel.com/rest/v2/lookups/countries : This API endpoint retrieves a list of countries supported by Deel.
GET https://api.letsdeel.com/rest/v2/lookups/currencies : This API endpoint retrieves the list of currencies used by Deel.
GET https://api.letsdeel.com/rest/v2/lookups/job-titles : This API endpoint retrieves a list of pre-defined job titles available on the Deel platform.
GET https://api.letsdeel.com/rest/v2/lookups/seniorities : This API endpoint retrieves a list of pre-defined seniority levels for roles in the Deel platform.
GET https://api.letsdeel.com/rest/v2/lookups/time-off-types : This API endpoint retrieves a list of pre-defined time off types available on the Deel platform.

Managers

GET https://api.letsdeel.com/rest/v2/managers : This API endpoint retrieves a list of all organization managers.

Organizations

GET https://api.letsdeel.com/rest/v2/organizations : This API endpoint retrieves the current organization details.

Payments

GET https://api.letsdeel.com/rest/v2/payments : The Retrieve Payments List API endpoint allows users to retrieve a list of payments made to Deel.
GET https://api.letsdeel.com/rest/v2/payments/{payment_id}/breakdown : The 'Get Payment Breakdown' API endpoint allows users to retrieve a detailed breakdown of a payment made to Deel.

People

POST https://api.letsdeel.com/rest/v2/people : This API endpoint allows you to create an employee hired under your own entity in Deel HR.
GET https://api.letsdeel.com/rest/v2/people/custom_fields : This API endpoint fetches all custom fields associated with People records, providing additional personalized information.
GET https://api.letsdeel.com/rest/v2/people/custom_fields/{field_id} : This API endpoint allows users to access details of a specific custom field by using the custom field ID.
GET https://api.letsdeel.com/rest/v2/people/{worker_id} : This API endpoint retrieves a single person in your organization using the unique worker ID.
PUT https://api.letsdeel.com/rest/v2/people/{worker_id}/custom_fields : This API endpoint allows you to add or update custom field values for a specific worker, ensuring their profile is up-to-date with the latest information.
DELETE https://api.letsdeel.com/rest/v2/people/{worker_id}/custom_fields/{field_id} : This API endpoint allows you to delete a specific custom field value from a worker's profile.
PUT https://api.letsdeel.com/rest/v2/people/{worker_id}/department : This API endpoint allows updating the department information of a worker identified by the 'worker_id' path parameter.
PATCH https://api.letsdeel.com/rest/v2/people/{worker_id}/personal : This API endpoint allows updating a worker's personal information using a PATCH request.
PUT https://api.letsdeel.com/rest/v2/people/{worker_id}/working-location : This API endpoint allows updating the working location of a worker identified by the 'worker_id' path parameter.

Teams

GET https://api.letsdeel.com/rest/v2/teams : This API endpoint retrieves a list of teams within your organization.

Timesheets

POST https://api.letsdeel.com/rest/v2/timesheets : This API endpoint allows users to submit work for a contractor by creating a timesheet.
POST https://api.letsdeel.com/rest/v2/timesheets/many/reviews : This API endpoint allows users to review a batch of timesheets to either approve or reject submitted work.
DELETE https://api.letsdeel.com/rest/v2/timesheets/{timesheet_id} : This API endpoint allows the user to delete a single timesheet entry by specifying the timesheet ID in the path parameters.
POST https://api.letsdeel.com/rest/v2/timesheets/{timesheet_id}/reviews : This API endpoint allows users to review a timesheet by approving or declining the submitted work.

Webhooks

POST https://api.letsdeel.com/rest/v2/webhooks : This API endpoint allows you to create a new webhooks subscription on the Deel platform.
GET https://api.letsdeel.com/rest/v2/webhooks/events/types : This API endpoint retrieves a list of webhook event types from the Deel platform.
DELETE https://api.letsdeel.com/rest/v2/webhooks/{id} : This API endpoint allows the user to delete a webhook subscription by specifying the webhook's unique identifier in the path parameter.

Workers

GET https://api.letsdeel.com/rest/v2/workers/{worker_id}/documents : This API endpoint retrieves a list of documents associated with a specific worker identified by the 'worker_id' path parameter.
GET https://api.letsdeel.com/rest/v2/workers/{worker_id}/documents/{document_id}/download : This API endpoint retrieves the download link for a specific worker's document in the Deel system.

Deel API FAQs‍

General Questions

1. What is the Deel API?

The Deel API allows developers to integrate Deel’s global hiring, payroll, and contract management features into their applications, automating HR and financial operations.

2. Who can use the Deel API?

The API is available for Deel customers and partners who need to integrate Deel’s features into their internal systems for automated contract management, payments, invoicing, and compliance tracking.

3. How do I get access to the Deel API?

You can access the Deel API by navigating to the Developer Center in your Deel account and generating an API token. Deel also provides a sandbox environment for testing.

4. Does Deel provide an API sandbox for testing?

Yes, Deel offers a sandbox environment that allows developers to test integrations before deploying them in a live setting. You can set up a sandbox account through the Developer Center.

Authentication & Security

5. How does authentication work in the Deel API?

Deel uses token-based authentication with two types of tokens:

Personal Tokens (linked to individual users, inheriting their permissions)
Organization Tokens (associated with service users, offering broader access)

All requests must include an Authorization: Bearer <your-token> header.

6. How do I generate an API token?

To generate an API token:

Log in to Deel and go to the Developer Center.
Click "Create API Token" and select either a personal or organization token.
Set the required scopes for API access.
Copy and securely store your token.

Endpoints & Functionalities

7. What key features does the Deel API support?

The Deel API includes endpoints for:

Contracts – Create, retrieve, and manage contracts.
Tasks – Automate task management.
Timesheets – Log and track work hours.
Milestones – Set and manage contract deliverables.
Payments – Automate salary and invoice processing.
Invoice Adjustments – Modify invoices dynamically.

8. How do I retrieve employee contract details via the API?

You can use the Contracts API endpoint:‍

GET /v1/contracts/{contract_id}
Authorization: Bearer <your-token>

This will return details about the specified contract.

9. Can I use the Deel API to process payroll?

Yes. The API enables payroll processing by integrating with Deel’s payments and invoice systems. You can schedule payments, retrieve payroll summaries, and handle tax compliance.

10. How do I manage invoices through the API?

You can use the invoice endpoints to create, retrieve, and adjust invoices:

GET /v1/invoices/{invoice_id}
Authorization: Bearer <your-token>

Integration & Compliance

11. What programming languages are supported for API integration?

The Deel API is RESTful and communicates using JSON, making it compatible with most programming languages, including Python, Node.js, Java, Ruby, and PHP.

12. Does the Deel API comply with global data security regulations?

Yes. Deel adheres to strict GDPR, SOC 2, and ISO 27001 compliance standards, ensuring secure handling of HR and payroll data.

13. What rate limits apply to the Deel API?

The Deel API enforces rate limits to prevent excessive API calls. Specific rate limits depend on the API tier and contract agreement.

14. Can I integrate Deel with other HR or accounting platforms?

Yes. Deel API can be integrated with HR systems (e.g., BambooHR, Workday), ERP software, and accounting tools (e.g., QuickBooks, Xero).

Support & Troubleshooting

15. Where can I find Deel API documentation?

You can find the official Deel API documentation at Deel API Docs.

16. How do I report API issues?

For technical support, contact Deel’s API support team at support@deel.com or submit a request through the Deel Developer Center.

17. What should I do if my API token is compromised?

If your API token is compromised:

Revoke the old token immediately from the Developer Center.
Generate a new token and update your API integrations.
Monitor for unauthorized API activity and notify Deel support if needed.

Get Started with Deel API Integration

Access the Developer Center: Log in to your Deel account, navigate to the 'More' icon, select 'Apps,' and then click on 'Developer Center' to enter the platform. Deel
Generate an Access Token:
- Choose between a personal token or an organization token based on your integration requirements.Deel
- Specify the necessary scopes for the token to control its access levels.
- Generate the token and securely store it, as it will not be visible again. Deel
Create a Sandbox Account: Within the Developer Center, initiate the creation of a sandbox account using your email and a password. Confirm the setup to access the testing environment.
Explore API Endpoints: Familiarize yourself with the available endpoints to effectively manage resources such as contracts, tasks, and payments. Detailed information on each endpoint is available in the API documentation. Deel

Additional Resources:

API Documentation: Comprehensive guides and references are available to assist developers in effectively utilizing the API. Deel
Integration Guides: For practical examples and best practices, refer to integration guides that provide insights into common API interactions.

For quick and seamless integration with Deel API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Deel API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, HRIS, Payroll and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Deel API.

To sign up for free, click here. To check the pricing, see our pricing page.

‍