> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/deel.md).

# Deel

Look up people data in Deel, the HR and payroll platform for global teams.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Deel      | Access Token   |

#### Deel

Connect to Deel with an organization access token to look up HRIS people data.

**Set up in Deel**

1. Prepare the Deel account or service that the workflow will access. Grant access to the required resources and operations.
2. **Access Token:** Create an organization access token in Deel under Apps & Perks > Developer Center. The token must include the people:read scope.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Deel**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                    |
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Access Token  | Yes      | Create an organization access token in Deel under Apps & Perks > Developer Center. The token must include the people:read scope. [Provider instructions](https://app.deel.com/). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Deel** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Direct Employee

Create a direct employee and employment contract in Deel.

**Inputs**

| Field                | Type            | Required | Description                                                                                                           |
| -------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
| Team                 | select (string) | Yes      | Select a Deel team, or type its ID manually. Options load from the selected connection.                               |
| Legal Entity         | select (string) | Yes      | Select a Deel legal entity, or type its ID manually. Options load from the selected connection.                       |
| First Name           | string          | Yes      | Employee first name.                                                                                                  |
| Last Name            | string          | Yes      | Employee last name.                                                                                                   |
| Personal Email       | string          | Yes      | Employee personal email.                                                                                              |
| Country              | string          | Yes      | Employee country code.                                                                                                |
| State/Region         | string          | No       | Optional employee state or region.                                                                                    |
| Nationality          | string          | Yes      | Employee nationality code.                                                                                            |
| Job Title            | string          | Yes      | Employee job title.                                                                                                   |
| Seniority            | select (string) | Yes      | Employee seniority. Options load from the selected connection.                                                        |
| Start Date           | string          | Yes      | Employment start date.                                                                                                |
| Salary               | number          | Yes      | Compensation amount.                                                                                                  |
| Currency             | string          | Yes      | Compensation currency.                                                                                                |
| Employment Type      | select (string) | No       | Employment type. Available values: FULL\_TIME, PART\_TIME. Default: FULL\_TIME.                                       |
| Compensation Scale   | select (string) | No       | Compensation scale. Available values: ANNUAL, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY. Default: ANNUAL. |
| Work Email           | string          | No       | Optional work email.                                                                                                  |
| External ID          | string          | No       | Optional external employee ID.                                                                                        |
| Part-Time Percentage | number          | No       | Required for PART\_TIME employment. Minimum: 1. Maximum: 100.                                                         |

**Outputs**

| Field              | Type   | Description                            |
| ------------------ | ------ | -------------------------------------- |
| Direct Employee    | object | The direct employee created in Deel.   |
| Direct Employee ID | string | ID of the created direct employee.     |
| Contract ID        | string | ID of the created employment contract. |
| Creation Status    | string | Creation result status.                |
| Result Message     | string | Human-readable result summary.         |

#### Get Worker

Retrieve one worker/person from Deel.

**Inputs**

| Field                    | Type            | Required | Description                                                                                        |
| ------------------------ | --------------- | -------- | -------------------------------------------------------------------------------------------------- |
| Worker                   | select (string) | Yes      | Select a worker, or type the worker/person ID manually. Options load from the selected connection. |
| Include Custom Fields    | boolean         | No       | Whether to include Deel custom fields.                                                             |
| Include Worker Relations | boolean         | No       | Whether to include worker relations.                                                               |

**Outputs**

| Field          | Type   | Description                       |
| -------------- | ------ | --------------------------------- |
| Worker         | object | The retrieved Deel worker/person. |
| Worker ID      | string | ID of the retrieved worker.       |
| Result Message | string | Human-readable result summary.    |

#### List Contracts

List contracts in your Deel organization.

**Inputs**

| Field              | Type            | Required | Description                                                                               |
| ------------------ | --------------- | -------- | ----------------------------------------------------------------------------------------- |
| Search             | string          | No       | Search contracts by title or worker name.                                                 |
| Contract Types     | string          | No       | Comma-separated contract types to include.                                                |
| Contract Statuses  | string          | No       | Comma-separated contract statuses to include.                                             |
| Team ID            | string          | No       | Optional Deel team ID filter.                                                             |
| Countries          | string          | No       | Comma-separated country codes.                                                            |
| Currencies         | string          | No       | Comma-separated currency codes.                                                           |
| External ID        | string          | No       | Optional external ID filter.                                                              |
| External ID Absent | boolean         | No       | Only contracts without external IDs.                                                      |
| Sort By            | select (string) | No       | Contract field to sort by. Available values: contract\_title, worker\_name.               |
| Order Direction    | select (string) | No       | Sort direction. Available values: asc, desc.                                              |
| Expand             | select (string) | No       | Optional extra contract data to include. Available values: cost\_centers, custom\_fields. |
| After Cursor       | string          | No       | Cursor for the next page.                                                                 |
| Limit              | integer         | No       | Maximum contracts to return. Minimum: 1. Maximum: 200.                                    |

**Outputs**

| Field          | Type          | Description                              |
| -------------- | ------------- | ---------------------------------------- |
| Contracts      | object\_array | The Deel contracts on this page.         |
| Contract IDs   | array         | IDs of the returned contracts.           |
| Total Count    | integer       | Total number of matching contracts.      |
| Cursor         | string        | Cursor for the next page.                |
| Has More       | boolean       | Whether more contracts may be available. |
| Result Message | string        | Human-readable result summary.           |

#### Get Invoices

Retrieve invoices from Deel.

**Inputs**

| Field            | Type            | Required | Description                                                    |
| ---------------- | --------------- | -------- | -------------------------------------------------------------- |
| Issued From Date | string          | No       | Only invoices issued on or after this date.                    |
| Issued To Date   | string          | No       | Only invoices issued before this date.                         |
| Status           | select (string) | No       | Invoice status filter. Available values: all.                  |
| Include          | select (string) | No       | Optional extra invoice data to include. Available values: cor. |
| Cursor           | string          | No       | Cursor for the next page.                                      |
| Limit            | integer         | No       | Maximum invoices to return. Minimum: 1. Maximum: 50.           |
| Offset           | integer         | No       | Zero-based result offset. Minimum: 0.                          |

**Outputs**

| Field          | Type          | Description                             |
| -------------- | ------------- | --------------------------------------- |
| Invoices       | object\_array | The Deel invoices on this page.         |
| Invoice IDs    | array         | IDs of the returned invoices.           |
| Total Count    | integer       | Total number of matching invoices.      |
| Cursor         | string        | Cursor for the next page.               |
| Has More       | boolean       | Whether more invoices may be available. |
| Result Message | string        | Human-readable result summary.          |

#### List People

List people in your Deel organization.

**Inputs**

| Field           | Type            | Required | Description                                                                                                                                                                                                                                                            |
| --------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Search          | string          | No       | Search people by name or email.                                                                                                                                                                                                                                        |
| Person Statuses | string          | No       | Comma-separated lifecycle statuses to include.                                                                                                                                                                                                                         |
| Hiring Types    | string          | No       | Comma-separated hiring types to include.                                                                                                                                                                                                                               |
| Fields          | string          | No       | Comma-separated fields to request from Deel.                                                                                                                                                                                                                           |
| Sort By         | select (string) | No       | Field to sort by. Available values: id, first\_name, last\_name, full\_name, email, country, birth\_date, hiring\_type, start\_date, team, job\_title, hiring\_status, completion\_date, direct\_manager, direct\_reports\_count, band\_placement, comparative\_ratio. |
| Sort Order      | select (string) | No       | Sort direction. Available values: asc, desc.                                                                                                                                                                                                                           |
| Limit           | integer         | No       | Maximum number of people to return. Minimum: 1. Maximum: 200.                                                                                                                                                                                                          |
| Offset          | integer         | No       | Zero-based result offset. Minimum: 0.                                                                                                                                                                                                                                  |

**Outputs**

| Field          | Type          | Description                                       |
| -------------- | ------------- | ------------------------------------------------- |
| People         | object\_array | The Deel people on this page.                     |
| Person IDs     | array         | IDs of the returned people, for downstream nodes. |
| Total Count    | integer       | Total number of people matching the filters.      |
| Has More       | boolean       | Whether more people exist after this page.        |
| Result Message | string        | Human-readable result summary.                    |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/deel.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
