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

• 1. Easy Data Access:
  • Seamless data access for integration with internal tools.
• 2. Automation:
  • Supports HR workflow automation to reduce manual tasks.
• 3. Custom Integration:
  • Flexible integration into existing tech stacks.
• 4. Real-Time Sync:
  • Ensures up-to-date information with real-time data synchronization.
• 5. Scalable:
  • Designed to scale with business needs.
• 6. Developer-Friendly:
  • Accessible for developers with efficient integration support.
• 7. Global Support:
  • Ensures functionality across different regions.
• 8. Error Handling and Logging:
  • Common in APIs for managing and troubleshooting issues.
• 9. Rate Limiting:
  • Typically included to manage API usage.
• 10. Version Control:
  • Often part of API management for updates and changes.
• 11. Data Transformation:
  • Ensures compatibility, though specifics weren't provided.
• 12. Webhook Support:
  • Commonly used for event-driven updates.
• 13. Detailed Analytics and Reporting:
  • Often provided for monitoring usage and performance.
• 14. Sandbox Environment:
  • Offers 60-day access to developer sandboxes for testing.

Deel API Endpoints

Adjustments

• POST https://api.letsdeel.com/rest/v2/adjustments : Create a New Adjustment
• GET https://api.letsdeel.com/rest/v2/adjustments/categories : Get Adjustment Categories for Organization
• DELETE https://api.letsdeel.com/rest/v2/adjustments/{adjustment_id} : Delete Adjustment

Candidates

• POST https://api.letsdeel.com/rest/v2/candidates : Add a Candidate to Deel
• PATCH https://api.letsdeel.com/rest/v2/candidates/{candidate_id} : Update Candidate

Contracts

• GET https://api.letsdeel.com/rest/v2/contract-templates : Retrieve Contract Templates
• GET https://api.letsdeel.com/rest/v2/contracts : Retrieve a list of contracts
• GET https://api.letsdeel.com/rest/v2/contracts/custom_fields : Fetch Custom Fields for Contracts
• GET https://api.letsdeel.com/rest/v2/contracts/custom_fields/{field_id} : Get Contract Custom Field Details
• POST https://api.letsdeel.com/rest/v2/contracts/gp : Create Global Payroll Contract
• PATCH https://api.letsdeel.com/rest/v2/contracts/{contract_id} : Add External ID to Deel Contract
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/adjustments : Get Adjustments for Specific Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/amendments : Amend Contract Details
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/custom_fields : Get Custom Field Values for a Contract
• DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/custom_fields/{field_id} : Delete Custom Field Value from Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/documents : Attach a File to Contract Document
• DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/invitations : Remove Contract Invitation
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/invoice-adjustments : Retrieve Invoice Line Items for a Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones : Add a New Milestone to Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones/many/reviews : Review Batch of Milestones
• DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones/{milestone_id} : Delete Milestone from Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones/{milestone_id}/reviews : Review Milestone to Approve or Decline Submitted Work
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/off-cycle-payments : Retrieve Off-Cycle Payments for a Contract
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/off-cycle-payments/{offcycle_payment_id} : Retrieve a Single Off-Cycle Payment
• DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/premium : Remove Deel Premium from Contract
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/preview : Retrieve IC and EOR Contract Agreement Content
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/signatures : Sign Contract as Client
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks : Retrieve Tasks for a Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks/many/reviews : Review Multiple Tasks for Approval or Decline
• DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks/{task_id} : Delete Task from Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks/{task_id}/reviews : Review Task for Approval or Decline
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/terminations : Terminate an Active Contract
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/timesheets : Retrieve Timesheets for a Contract

Departments

• GET https://api.letsdeel.com/rest/v2/departments : Get List of Organization Departments

Employee of Record (EOR)

• POST https://api.letsdeel.com/rest/v2/eor : Create Employee of Record Contract Quote
• POST https://api.letsdeel.com/rest/v2/eor/employment_cost : Determine EOR Employee Costs
• GET https://api.letsdeel.com/rest/v2/eor/validations/{country_code} : Retrieve Hiring Guide Data for a Country
• GET https://api.letsdeel.com/rest/v2/eor/workers/{worker_id}/payslips/{payslip_id}/download : Get Download URL for EOR Payslip
• GET https://api.letsdeel.com/rest/v2/eor/{contract_id}/benefits : Retrieve EOR Contract Benefits

Global Payroll (GP)

• GET https://api.letsdeel.com/rest/v2/gp/legal-entities/{legal_entity_id}/reports : Get Global Payroll Events by Legal Entity
• GET https://api.letsdeel.com/rest/v2/gp/reports/{gp_report_id}/gross_to_net : Get Global Payroll Gross-to-Net Reports
• GET https://api.letsdeel.com/rest/v2/gp/reports/{gp_report_id}/gross_to_net/csv : Download Global Payroll Gross-to-Net Report
• PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/address : Update Global Payroll Employee Address
• GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/banks : Retrieve Employee Bank Accounts
• GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/banks/guide : Retrieve Bank Form Guide for Employee
• PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/banks/{bank_id} : Modify Bank Account for an Employee
• PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/compensation : Update Global Payroll Employee Compensation
• PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/employee-information : Update Global Payroll Employee Information
• GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/payslips : Get Payslips for an Employee
• GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/payslips/{payslip_id}/download : Get Download URL for GP Payslip
• PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/pto-policy : Update PTO Policy of Global Payroll Employee
• POST https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/terminations : Request Termination for Global Payroll Employee

Invoice Adjustments

• POST https://api.letsdeel.com/rest/v2/invoice-adjustments : Create Invoice Adjustment
• POST https://api.letsdeel.com/rest/v2/invoice-adjustments/many/reviews : Review Multiple Invoice Adjustments
• DELETE https://api.letsdeel.com/rest/v2/invoice-adjustments/{invoice_adjustment_id} : Delete Invoice Adjustment
• POST https://api.letsdeel.com/rest/v2/invoice-adjustments/{invoice_adjustment_id}/reviews : Review Invoice Adjustment

Invoices

• GET https://api.letsdeel.com/rest/v2/invoices : Retrieve Paid Invoices
• GET https://api.letsdeel.com/rest/v2/invoices/deel : Retrieve Deel Invoices

Legal Entities

• GET https://api.letsdeel.com/rest/v2/legal-entities : Retrieve Legal Entities

Lookups

• GET https://api.letsdeel.com/rest/v2/lookups/countries : Retrieve Supported Countries by Deel
• GET https://api.letsdeel.com/rest/v2/lookups/currencies : Retrieve List of Currencies
• GET https://api.letsdeel.com/rest/v2/lookups/job-titles : Retrieve Pre-defined Job Titles
• GET https://api.letsdeel.com/rest/v2/lookups/seniorities : Retrieve Seniority Levels
• GET https://api.letsdeel.com/rest/v2/lookups/time-off-types : Retrieve Pre-defined Time Off Types

Managers

• GET https://api.letsdeel.com/rest/v2/managers : List Organization Managers

Organizations

• GET https://api.letsdeel.com/rest/v2/organizations : Retrieve Current Organization Details

Payments

• GET https://api.letsdeel.com/rest/v2/payments : Retrieve Payments List
• GET https://api.letsdeel.com/rest/v2/payments/{payment_id}/breakdown : Get Payment Breakdown

People

• POST https://api.letsdeel.com/rest/v2/people : Create Employee in Deel HR
• GET https://api.letsdeel.com/rest/v2/people/custom_fields : Fetch Custom Fields for People Records
• GET https://api.letsdeel.com/rest/v2/people/custom_fields/{field_id} : Get Custom Field Details
• GET https://api.letsdeel.com/rest/v2/people/{worker_id} : Retrieve a Single Person in Your Organization
• PUT https://api.letsdeel.com/rest/v2/people/{worker_id}/custom_fields : Add or Update Custom Field Values for a Worker
• DELETE https://api.letsdeel.com/rest/v2/people/{worker_id}/custom_fields/{field_id} : Delete Custom Field from Worker's Profile
• PUT https://api.letsdeel.com/rest/v2/people/{worker_id}/department : Update Worker Department
• PATCH https://api.letsdeel.com/rest/v2/people/{worker_id}/personal : Update Worker's Personal Information
• PUT https://api.letsdeel.com/rest/v2/people/{worker_id}/working-location : Update Worker Working Location

Teams

• GET https://api.letsdeel.com/rest/v2/teams : Retrieve Organization Teams

Timesheets

• POST https://api.letsdeel.com/rest/v2/timesheets : Submit Work for a Contractor
• POST https://api.letsdeel.com/rest/v2/timesheets/many/reviews : Review Batch of Timesheets
• DELETE https://api.letsdeel.com/rest/v2/timesheets/{timesheet_id} : Delete a Single Timesheet Entry
• POST https://api.letsdeel.com/rest/v2/timesheets/{timesheet_id}/reviews : Review Timesheet

Webhooks

• POST https://api.letsdeel.com/rest/v2/webhooks : Create a new webhooks subscription
• GET https://api.letsdeel.com/rest/v2/webhooks/events/types : Retrieve Webhook Event Types
• DELETE https://api.letsdeel.com/rest/v2/webhooks/{id} : Delete Webhook Subscription

Workers

• GET https://api.letsdeel.com/rest/v2/workers/{worker_id}/documents : Retrieve Worker Documents
• GET https://api.letsdeel.com/rest/v2/workers/{worker_id}/documents/{document_id}/download : Get Worker Document Download Link

Working Locations

• GET https://api.letsdeel.com/rest/v2/working-locations : Get Organization Working Locations

SCIM

• GET https://api.letsdeel.com/scim/v2/Users : List users
• PATCH https://api.letsdeel.com/scim/v2/Users/{id} : Partially update/patch a user

‍

Deel API FAQs‍

1. How do I create a new contractor in Deel using the API?some text
   • You can use the POST /contracts endpoint to create new contractor contracts. Refer to the API documentation for the required parameters and request body format.
   • Source: Deel API Documentation: https://developer.deel.com/docs/welcome
2. Can I use the Deel API to automate payroll processing?some text
   • Yes, the Deel API allows you to automate payroll processing by creating pay runs, generating payslips, and making payments.
   • Source: Deel API Documentation: https://developer.deel.com/docs/welcome
3. How does authentication work with the Deel API?some text
   • Deel uses API tokens for authentication. You can generate API tokens in the Deel Developer Center.
   • Source: Deel API Documentation: https://developer.deel.com/docs/welcome
4. What are the rate limits for the Deel API?some text
   • Deel has rate limits in place to prevent abuse. Refer to the official documentation for the specific rate limits and potential throttling mechanisms.
   • Source: Deel API Documentation: https://developer.deel.com/docs/welcome
5. How can I handle errors and exceptions in Deel API integrations?some text
   • Deel API returns detailed error messages in the response body. Handle different error codes appropriately to ensure your integration is robust.
   • Source: Deel API Documentation: https://developer.deel.com/docs/welcome

Get Started with Deel API Integration

For quick and seamless integration with Deel API, Knit APIoffers a convenient solution. It’s AI powered integration platform allowsyou to build any DeelAPI Integration use case. By integrating with Knit just once, you canintegrate with multiple other ATS, HRIS, Payroll and other systems in one gowith a unified approach. Knit takes care of all the authentication,authorization, and ongoing integration maintenance. This approach not onlysaves 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.

‍