> ## Documentation Index
> Fetch the complete documentation index at: https://lava.so/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Deel

> Deel REST API access for reading people, contracts, invoices, and legal entities for a connected Deel organization (global payroll, EOR, and contractors).

Deel REST API access for reading people, contracts, invoices, and legal entities for a connected Deel organization (global payroll, EOR, and contractors). Use when an agent needs workforce, contract, or invoice data from Deel. Routes through Pipedream Connect, so Lava holds no Deel token.

5 example endpoints available through Lava's AI Gateway. See the [Deel API docs](https://developer.deel.com/api/reference) for full documentation.

<Warning>This provider requires your own credentials — connect your API key or OAuth account before use.</Warning>

<Info>This is a **catch-all provider** — any valid URL under `https://api.letsdeel.com` is supported. Deel REST API v2. Base [https://api.letsdeel.com](https://api.letsdeel.com), paths under /rest/v2. Reads: /rest/v2/people (workforce directory), /rest/v2/people/\{id} (one), /rest/v2/contracts, /rest/v2/invoices (defaults to paid; pass status=all for all), /rest/v2/legal-entities. GET /rest/v2/organizations returns the connected organization (an identity probe; resolves the org from the token). Pagination is offset and limit; responses carry data\[] plus a page object \{ offset, total\_rows, items\_per\_page }. Auth is brokered by Pipedream, do not send an Authorization header. This provider is read-only: only GET requests are supported. The endpoints below are curated examples.</Info>

## Endpoints

### List people (the workforce directory). Paginate with offset and limit.

**GET** `https://api.letsdeel.com/rest/v2/people?limit=50&offset=0` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://api.letsdeel.com/rest/v2/people?limit=50&offset=0', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapi.letsdeel.com%2Frest%2Fv2%2Fpeople%3Flimit%3D50%26offset%3D0" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### Retrieve a single person by id.

**GET** `https://api.letsdeel.com/rest/v2/people/{id}` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://api.letsdeel.com/rest/v2/people/{id}', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapi.letsdeel.com%2Frest%2Fv2%2Fpeople%2F%7Bid%7D" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### List contracts.

**GET** `https://api.letsdeel.com/rest/v2/contracts` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://api.letsdeel.com/rest/v2/contracts', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapi.letsdeel.com%2Frest%2Fv2%2Fcontracts" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### List invoices (defaults to paid; pass status=all for every status).

**GET** `https://api.letsdeel.com/rest/v2/invoices?status=all` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://api.letsdeel.com/rest/v2/invoices?status=all', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapi.letsdeel.com%2Frest%2Fv2%2Finvoices%3Fstatus%3Dall" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### Get the connected organization (id and name). Use as an identity probe after connect.

**GET** `https://api.letsdeel.com/rest/v2/organizations` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://api.letsdeel.com/rest/v2/organizations', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapi.letsdeel.com%2Frest%2Fv2%2Forganizations" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

## Next Steps

<CardGroup cols={2}>
  <Card title="All Providers" icon="grid" href="/gateway/supported-providers">
    Browse all supported AI providers
  </Card>

  <Card title="Forward Proxy" icon="route" href="/gateway/forward-proxy">
    Learn how to construct proxy URLs and authenticate requests
  </Card>
</CardGroup>