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
We are continuing to expand the operations available via the API, including expanding capabilities with our other products.
If you’re interested in learning more about the current or future functionality of Deel API, you can contact us 24/7, or reach out to your Deel point of contact.
You must be an Org Admin or IT Developer Admin on Deel in order to build apps using Deel's API.
Implementation
If you are interested in implementing the API with your internal tools, you can access the API documentation.
You will first need to 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 - Select the App Store tab on your home page to enter the Developer Center
Select the API access & Sandbox tab to view the API access token section
✅ Step 2 - Generate token
You can 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.
You can also generate an Organization Token, 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. You cannot sign a contract using an organization token.
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
You won't be able to see the token again, so make sure you remember where you've copied it!
You can find more information on token creation in our 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
You can click Go To Sandbox to enter the sandbox immediately
✅ Step 3 - Access the sandbox from the Deel platform by clicking Go To Sandbox
You can find more information on sandbox creation in our API documentation guides.
FAQ
How long does it take to set up an API?
This varies depending on the system the prospect is looking to sync the Deel platform; what resources you have available; as well as the range of functionalities you wish to set up within the API.
Setting up a basic 'proof of concept' may only take one day, but usually, we see the process takes a couple of weeks based on internal prioritization of the implementation.
Is Deel involved with the implementation process?
Deel is not at all involved in the implementation process and any consultative or development work should come from your own resources.
If you do have any specific questions about the API itself, we can help answer any questions you may have, you can reach out to the Deel Support group or to your Deel point of contact with these.
What is the difference between a personal token and an organization token?
Personal tokens: These tokens are tied to a user profile. You can use these tokens if you want to limit API access to a user's personal access in Deel. If the profile that created this token is deleted, the token will also expire. This is why we recommend using organization tokens.
Organization tokens: Organization tokens, unlike personal tokens, are not related to a user profile. Therefore, these tokens can access all resources and do not expire if the user who created them leaves. You cannot sign a contract 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?
We’re happy to answer any technical questions you may have, or potentially share any insights on the integration you’re planning to build, but we don’t actively get involved in the implementation process itself.