Using the Deel API, you can connect your company’s internal tools to Deel for an even smoother, personalized experience.
This enables you to implement customizable integrations between your company’s internal tools and the Deel platform, so you can determine what data transfer happens, and where. That makes managing your payroll and compliance operations even easier.
In this article:
Current functionality
These are the current capabilities of Deel API, which are currently centered around our contractor product. The key API resources include:
- Contracts
- Tasks
- Timesheets
- Milestones
- Off-cycle payments
- Invoice adjustments
- Organizations
- Legal-entities
- Lookups
- Groups
Deel is continuing to expand the operations available via the API, including expanding capabilities with our other products.
If interested in learning more about the current or future functionality of Deel API, contact support 24/7, or reach out to assigned Deel point of contact.
One must be an Org Admin or IT Developer Admin on Deel in order to build apps using Deel's API.
Implementation
If interested in implementing the API with your internal tools, access he API documentation.
First generate an access token, then use the token to create an API Sandbox account.
API users can generate personal tokens or tokens that are not associated to a real user, called organization tokens.
How to generate an access token
✅ Step 1 - From the Deel home page, select the More icon and Apps icon. Click on the Developer Center button to enter.
Select the API access & Sandbox tab to view the API access token section
✅ Step 2 - Generate token
Select a personal token or an organization token.
Personal API access tokens are associated to the user who generates the token. Therefore, the token will only have access to what the user can access; and the token will expire if the user leaves the company.
An Organization Token can also be generated, which are associated to service users. Because they aren't connected to real user profiles, they never expire or leave the company. Therefore, these tokens can access all resources and do not expire but can't be used to sign a contract.
Click Generate Token.
✅ Step 3 - Select the scopes for the access token and click Generate
✅ Step 4 - Copy the token and store it in a safe place
The token won't be visible again, so ensure it's copied and stored securely!
Find more information on sandbox creation in the API documentation guides.
Create an API sandbox account
The Deel API Sandbox is a test account that our clients and partners can use to test the API with sample data during the implementation phase. Users will be able to easily create a sandbox account (containing sample data) from the developer center in the Deel platform.
✅ Step 1 - Create new sandbox with an email address and password
✅ Step 2 - Click Confirm to create a sandbox
Click on Go To Sandbox to enter the sandbox immediately
✅ Step 3 - Access the sandbox from the Deel platform by clicking Go To Sandbox
Find more information on sandbox creation in the API documentation guides.
FAQ
How long does it take to set up an API?
The setup time for an API varies depending on the system a client is looking to sync with Deel, the resources available, and the range of functionalities they wish to set up within the API. Setting up a basic 'proof of concept' may take only one day, but typically, the process takes a couple of weeks based on internal prioritization of the implementation.
Is Deel involved with the implementation process?
Deel is not involved in the implementation process. Any consultative or development work should come from a client's own resources. However, if there are specific questions about the API itself, Deel can help answer them. Clients can reach out to Deel Support or assigned point of contact for assistance.
What is the difference between a personal token and an organization token?
Personal tokens: These tokens are tied to a user profile and can be used to limit API access to a user's personal access in Deel. If the profile that created the token is deleted, the token will also expire. Therefore, it is recommended to use organization tokens.
Organization tokens: Unlike personal tokens, organization tokens are not related to a user profile. These tokens can access all resources and do not expire if the user who created them leaves. However, contracts cannot be signed using an organization token.
What functionality is available for EOR services?
EOR contract creation and time-off logging is available.
What support does Deel provide during the implementation process?
Deel is happy to answer any technical questions clients may have or share insights on the integration they are planning to build. However, won't actively get involved in the implementation process itself.