For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeel Home
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
  • Resources
    • Blog
    • Community
    • API spec
  • Get Started
    • Quickstart
    • Sandbox
  • Essentials
    • Authentication
    • API versioning
    • OAuth 2.0
    • Rate Limits
    • Idempotency
    • Best Practices
  • Webhooks
    • Introduction
    • Quickstart
    • No Code
    • Events
    • Simulations
  • Partners
    • Introduction
    • Getting Started
    • Publishing to App Store
LogoLogo
SupportDeel Home
On this page
  • Get started in three steps
  • Step 1: Create a Deel Account
  • Step 2: Set Up API Sandbox
  • Step 3: Make Your First API Call
  • Try a Sample App
  • Next steps
  • Essential API Topics
  • Explore Deel Services
Get Started

Quickstart

Was this page helpful?

Sandbox

Next
Built with

Get started in three steps

Learn how to create a sandbox environment and use it to test your API calls safely before going to production.

Step 1: Create a Deel Account

Sign up for Deel

If you don’t already have a Deel account, create one first:

  1. Go to app.deel.com
  2. Click Sign Up and complete the registration process
  3. Verify your email address
Already have a Deel account? Skip to Step 2.

Step 2: Set Up API Sandbox

The API Sandbox is a separate testing environment where you can safely test API calls without affecting real data or production systems.

Create your sandbox environment
  1. Log into your Deel account at app.deel.com
  2. Navigate to the Developer Center (usually found in settings or developer menu)
  3. Click on the API Sandbox tab
  4. Click Create Sandbox
  5. Enter a unique email address and password for your sandbox account
  6. Click Confirm to create the sandbox

Read more about sandbox in this article.

Get your API credentials

After creating your sandbox:

  1. In the Developer Center, locate your API Key or Access Token
  2. Copy and save it securely (treat it like a password)
  3. Note the sandbox API base URL: https://api-sandbox.demo.deel.com/rest/v2

Never share your API credentials or commit them to version control. Use environment variables instead.

Step 3: Make Your First API Call

Test the API

Try a simple API request to verify your setup:

$curl -X GET "https://api-sandbox.demo.deel.com/rest/v2/contracts" \
>  -H "Authorization: Bearer YOUR_API_KEY" \
>  -H "Content-Type: application/json"

Replace YOUR_API_KEY with your actual sandbox API key.

A successful response means you’re ready to start building! If you get an error, double-check your API key and ensure you’re using the sandbox URL.

Ready for production?

When you’re ready to move to production:

  1. Go back to Developer Center
  2. Switch from Sandbox to Production mode
  3. Generate production API credentials (different from sandbox)
  4. Update your API base URL to: https://api.letsdeel.com/rest/v2

Production API calls affect real data and may trigger actual business processes. Always test thoroughly in sandbox first.

Try a Sample App

Want to see the API in action right away? Clone one of our pre-built sample applications:

Node.js Quickstart

Full-stack example with Express and React.

Next steps

Essential API Topics

Before diving into specific services, familiarize yourself with these core concepts:

Authentication

Learn how to authenticate your API requests.

Webhooks

Set up webhooks to receive real-time updates.

Rate Limits

Understand API rate limits and best practices.

Idempotency

Ensure safe retry logic for your API calls.

Explore Deel Services

Choose the service that fits your use case:

Employer of Record

Hire employees globally without setting up local entities.

Contractors

Manage the full contractor lifecycle from contracts to payments.

Global Payroll

Run payroll in 120+ countries with local compliance.

HRIS

Manage your team’s information and organizational structure.

Deel IT

Securely manage devices and applications.

Platform APIs

Access reports, screenings, immigration, and more.

Need help? Contact Deel Support or check out the full API reference.