> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.deel.wtf/api/stable/quickstart/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.deel.wtf/_mcp/server.

# Quickstart

> Start building awesome documentation in minutes

## 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](https://app.deel.com)
2. Click **Sign Up** and complete the registration process
3. Verify your email address

> **Note**
>
> 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](https://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

> **Info**
>
> Read more about sandbox in this [article](/api/sandbox).

#### 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-staging.letsdeel.com/rest`

> **Tip**
>
> 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:

```bash
curl -X GET "https://api-staging.letsdeel.com/rest/contracts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
```

Replace `YOUR_API_KEY` with your actual sandbox API key.

> **Note**
>
> 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`

> **Warning**
>
> 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](https://github.com/letsdeel/public-api-samples/tree/dev/samples/create-ic-fixed-rate-contract)

Full-stack example with Express and React.

## Next steps

### Essential API topics

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

#### [Authentication](/api/authentication)

Learn how to authenticate your API requests.

#### [Webhooks](/api/webhooks/quickstart)

Set up webhooks to receive real-time updates.

#### [Rate Limits](/api/rate-limits)

Understand API rate limits and best practices.

#### [Idempotency](/api/idempotency)

Ensure safe retry logic for your API calls.

### Explore Deel services

Choose the service that fits your use case:

#### [Employer of Record](/api/employer-of-record/introduction)

Hire employees globally without setting up local entities.

#### [Contractors](/api/contractors/introduction)

Manage the full contractor lifecycle from contracts to payments.

#### [Global Payroll](/api/global-payroll/introduction)

Run payroll in 120+ countries with local compliance.

#### [HRIS](/api/hris)

Manage your team's information and organizational structure.

#### [Deel IT](/api/deel-it)

Securely manage devices and applications.

#### [Platform APIs](/api/platform/introduction)

Access reports, screenings, immigration, and more.

> **Note**
>
> **Need help?** Contact [Deel Support](https://app.deel.com/contact-support) or check out the [full API reference](/api/reference).

> Build apps and integrations that extend and enhance the Deel services.