***

title: Quickstart
description: 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

<AccordionGroup>
  <Accordion icon="user-plus" title="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.
    </Note>
  </Accordion>
</AccordionGroup>

### 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.

<AccordionGroup>
  <Accordion icon="flask" title="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).
    </Info>
  </Accordion>

  <Accordion icon="key" title="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`

    <Tip>
      Never share your API credentials or commit them to version control. Use environment variables instead.
    </Tip>
  </Accordion>
</AccordionGroup>

### Step 3: Make Your First API Call

<AccordionGroup>
  <Accordion icon="code" title="Test the API">
    Try a simple API request to verify your setup:

    ```bash
    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.

    <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.
    </Note>
  </Accordion>

  <Accordion icon="rocket" title="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`

    <Warning>
      Production API calls affect real data and may trigger actual business processes. Always test thoroughly in sandbox first.
    </Warning>
  </Accordion>
</AccordionGroup>

## Try a Sample App

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

<Card title="Node.js Quickstart" icon="fa-brands fa-node-js" href="https://github.com/letsdeel/public-api-samples/tree/dev/samples/create-ic-fixed-rate-contract">
  Full-stack example with Express and React.
</Card>

## Next steps

### Essential API Topics

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

<CardGroup cols={2}>
  <Card title="Authentication" icon="fa-light key" href="/api/authentication">
    Learn how to authenticate your API requests.
  </Card>

  <Card title="Webhooks" icon="fa-light webhook" href="/api/webhooks/quickstart">
    Set up webhooks to receive real-time updates.
  </Card>

  <Card title="Rate Limits" icon="fa-light gauge" href="/api/rate-limits">
    Understand API rate limits and best practices.
  </Card>

  <Card title="Idempotency" icon="fa-light repeat" href="/api/idempotency">
    Ensure safe retry logic for your API calls.
  </Card>
</CardGroup>

### Explore Deel Services

Choose the service that fits your use case:

<CardGroup cols={2}>
  <Card title="Employer of Record" icon="fa-light globe" href="/api/employer-of-record/introduction">
    Hire employees globally without setting up local entities.
  </Card>

  <Card title="Contractors" icon="fa-light file-invoice" href="/api/contractors/introduction">
    Manage the full contractor lifecycle from contracts to payments.
  </Card>

  <Card title="Global Payroll" icon="fa-light money-bill" href="/api/global-payroll/introduction">
    Run payroll in 120+ countries with local compliance.
  </Card>

  <Card title="HRIS" icon="fa-light users" href="/api/hris">
    Manage your team's information and organizational structure.
  </Card>

  <Card title="Deel IT" icon="fa-light laptop" href="/api/deel-it">
    Securely manage devices and applications.
  </Card>

  <Card title="Platform APIs" icon="fa-light cloud" href="/api/platform/introduction">
    Access reports, screenings, immigration, and more.
  </Card>
</CardGroup>

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