Authentication
Overview
All Deel API requests require authentication and must be made over HTTPS. Deel supports two authentication methods:
Simple token-based authentication for server-to-server integrations (covered on this page)
Industry-standard protocol for user-authorized app access (see OAuth2 page)
This page covers API tokens. For OAuth2 authentication, see the OAuth2 documentation.
Token types
Deel supports three API token variants. All are used as Bearer tokens in the Authorization header, but they differ in who they represent, how you obtain them, and which endpoints they can call.
For OAuth2-based authentication, see the OAuth2 documentation.
API tokens
API tokens provide a straightforward way to authenticate server-to-server API requests. Tokens are used as Bearer tokens in the Authorization header.
Generating an API token
Choose token type
Select the appropriate token type for your use case:
Organization token
Personal token
Organization token: Provides access to all organization resources
Use this for:
- Reading contract data
- Managing timesheets
- Invoice adjustments
- Accounting data
- SCIM API access
Using API tokens
Include your token in the Authorization header as a Bearer token:
Best practices for API tokens
Security
- Never commit tokens to version control
- Use environment variables to store tokens
- Rotate tokens regularly to minimize security risks
- Use HTTPS only for all API requests
- Delete unused tokens immediately
Scope selection
- Use the least privilege principle: Only grant the minimum scopes needed
- Separate tokens by function: Create different tokens for different integrations
- Organization vs personal: Choose based on your access requirements
Token rotation
API credentials should be changed regularly. Employees leave, API credentials can be accidentally committed to version control, and security flaws can be discovered.
When to rotate:
- Proactively on a regular schedule (quarterly recommended)
- Immediately if potential compromise is suspected
- When team members with access leave
Worker API tokens
A worker API token authenticates as a specific EOR worker rather than the client organization. Use it when an integration needs to act on behalf of an employee — for example, when the worker submits their own resignation or retrieves their own pending offboarding tasks.
Unlike organization and personal tokens, worker tokens are generated programmatically through the API, not the Developer Center dashboard.
Generating a worker API token
Call the Create worker access token endpoint using a client API token. The response returns a Bearer token scoped to a single worker.
Using a worker API token
Send the worker token in the Authorization header like any other Bearer token:
Limitations
- Worker-scoped: A worker token can only act on the worker it was issued for.
- Limited endpoint coverage: Worker tokens authenticate only against worker-side endpoints (paths under
/rest/v2/eor/workers/). Calling standard client endpoints with a worker token returns403 Forbidden. - Not interchangeable with client tokens: Standard client API tokens cannot call worker-side endpoints either. Flows that span both sides — such as client-initiated resignation — require both token types.
When to use a worker API token
For flows that combine both token types, see the EOR offboarding guide.
When to use API tokens vs OAuth2
Scopes
Scopes control granular access to different parts of the Deel API. When creating a token, you’ll select the scopes (permissions) it needs.
Least privilege principle: Only grant the minimum scopes necessary for your use case. Each API endpoint lists its required scopes in the API reference.
Common scope patterns:
- Read scopes:
{resource}:read(e.g.,contracts:read,people:read) - Write scopes:
{resource}:write(e.g.,contracts:write,timesheets:write)
Check each endpoint’s documentation to see which scopes are required.
Troubleshooting
401 Unauthorized error
Common causes:
- Invalid or expired token
- Missing
Authorizationheader - Token doesn’t have required scopes
Solutions:
- Verify token is correct and not expired
- Check header formatting:
Authorization: Bearer TOKEN - Ensure token has necessary scopes
- Generate a new token if needed
403 Forbidden error
Common causes:
- Token lacks required scopes for the endpoint
- Attempting to access resources outside token’s permissions
Solutions:
- Review the scopes assigned to your token
- Generate a new token with appropriate scopes
Token expired
Solution:
- Generate a new token in Developer Center
- Update your application with the new token
- Consider setting up a rotation schedule
HTTPS required error
Cause:
- Attempting to make requests over HTTP
Solution:
- All API requests must use HTTPS
- Update your base URL to
https://api.letsdeel.com/rest
Security best practices
Secure storage
Store credentials in environment variables or secure vaults, never in code
Regular rotation
Rotate tokens quarterly or when team members leave
Minimal scopes
Request only the scopes your application absolutely needs
Monitor usage
Log and monitor API calls to detect unusual patterns
HTTPS only
Never make API requests over unencrypted connections
Revoke quickly
Immediately revoke tokens if compromise is suspected