The Deel API lets you connect your company's internal tools to Deel, so you can build custom integrations, automate workflows, and keep data in sync across systems, on your terms.
What you can do with the Deel API
With the Deel API, you can:
- Automate contractor and EOR workflows, including contracts, tasks, timesheets, milestones, and off-cycle payments
- Sync organizations, legal entities, and groups between Deel and your internal systems
- Trigger real-time automations with webhooks when contracts, payments, or approvals change
Deel is continuously expanding what's available through the API. For the full, up-to-date list of endpoints and capabilities, see the API reference.
Who can build with the API: You need to be an Org Admin or IT Developer Admin on Deel to generate API tokens and build integrations.
Getting started
To start building, head to the Deel Developer Center for everything you need, including:
- Quickstart guide – a walkthrough of your first API call
- Authentication – how to generate a personal or organization API token
- Sandbox setup – how to create a test account with sample data before you go live
Step 1 - Open Developer settings
- In the left sidebar, select Apps & Automation to expand its submenu.
- Select App Store.
- If a welcome or promotional overlay appears on the Apps overview page, close it using the X in the upper-right corner.
- Locate the Looking for Developer Center? panel near the lower-left area of the page and select Go to Developer Center.
Note: In the current interface, token management is available on the Developer page under Tokens. You may not see a separate API access & Sandbox tab.
Step 2 - Generate an access token
- On the Developer page, select Tokens if it is not already selected.
- Select Generate new token in the upper-right area of the token list.
- Enter a descriptive value in the required Label field.
- Under Token type, choose Organization token (Recommended) for an organization-level integration or Personal token for a token tied to an individual user profile.
- Continue through the form to select the appropriate scopes and permission settings, then review and generate the token.
Caution: Copy and store the token immediately after generation. It will not be visible again after this screen.
Note: Personal tokens are tied to a user profile and expire when that user leaves. Organization tokens are not tied to a user profile, do not expire, but cannot be used to sign contracts.
Step 3 - Create an API Sandbox account
- In Developer settings, select Create new sandbox.
- Enter an email address and password for the sandbox account.
- Select Confirm to create the sandbox.
- Select Go to Sandbox to access the test environment immediately.
Tip: Use the Sandbox to test the API with sample data before connecting to your production Deel account.
Troubleshooting
| Problem | Did you try? | How to fix |
|---|---|---|
| The Developer Center is not visible in the App Store | Confirming you have the required Developer settings and token-management permissions | Contact an organization administrator to verify or grant the required permissions. |
| The Apps overview page is blocked by a pop-up | Closing the overlay with the X in its upper-right corner | Close the overlay, then select Go to Developer Center. Promotional overlays may appear only for some accounts or sessions. |
| I cannot find API access & Sandbox, Personal token, or Organization token tabs | Opening Developer and selecting Tokens | The interface has changed. Select Generate new token; the organization and personal token choices are available inside the Generate access token form. |
| The Generate new token button is unavailable or Developer is missing | Confirming your role permissions | Request Developer settings and token-management permission from an organization administrator. |
| The generated token is no longer visible | Checking whether you copied and stored the token immediately after generation | Generate a new token — existing tokens cannot be retrieved. Store the new token securely before closing the window. |
| The Sandbox account is not accessible after creation | Selecting Go to Sandbox immediately after selecting Confirm | Log in to the Sandbox using the email address and password used during creation, or create a new Sandbox account. |