Deel: Create a direct employee
Deel people.createAdirectEmployee: arguments, response, policy and SDK examples.
← People operations · Get started
Operation deel.people_createadirectemployee_v2026_01_01
Provider route: POST /people. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["people"]["createAdirectEmployee"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.people.createAdirectEmployee(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.people.create_adirect_employee(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | |
body.data | Model | Required within parent | Expand Create a direct employee — request body — body data |
Referenced models: Create a direct employee — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Create a direct employee — 201 response body |
Referenced models: Create a direct employee — 201 response body
Schemas
Section titled “Schemas”4 more schemas are linked from the tables above, on the schema pages.
Create a direct employee — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a direct employee — 201 response body — data |
Referenced models: Create a direct employee — 201 response body — data
Create a direct employee — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client | Model | Required within parent | Expand Create a direct employee — request body — body data client The entity that is hiring the employee |
compensation_details | Model | Required within parent | Expand Create a direct employee — request body — body data compensation details The compensation details of the employee |
employee | Model | Required within parent | Expand Create a direct employee — request body — body data employee The person that is being hired |
employment | Model | Required within parent | Expand Create a direct employee — request body — body data employment The employment details of the employee |
invitation | Model | Optional | Expand Create a direct employee — request body — body data invitation Optional invitation configuration for the new hire. Defaults to 'IMMEDIATE' if not provided. |
Referenced models: Create a direct employee — request body — body data client, Create a direct employee — request body — body data compensation details, Create a direct employee — request body — body data employee, Create a direct employee — request body — body data employment, Create a direct employee — request body — body data invitation
Create a direct employee — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
compensation_details | Model | Required within parent | Expand Create a direct employee — 201 response body — data compensation details The compensation details of the employee |
employee | Model | Required within parent | Expand Create a direct employee — 201 response body — data employee The person that is being hired |
employment | Model | Required within parent | Expand Create a direct employee — 201 response body — data employment The employment details of the employee |
id | string | Required within parent | The unique identifier of the created employee record Format: uuid |
Referenced models: Create a direct employee — 201 response body — data compensation details, Create a direct employee — 201 response body — data employee, Create a direct employee — 201 response body — data employment
Create a direct employee — request body — body data client
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The entity that is hiring the employee |
department | Model | Optional | Expand Create a direct employee — request body — body data client department The department information for the employee |
legal_entity | Model | Required within parent | Expand Create a direct employee — request body — body data client legal entity The legal entity information for the employee |
team | Model | Required within parent | Expand Create a direct employee — request body — body data client team The team information for the employee |
Referenced models: Create a direct employee — request body — body data client department, Create a direct employee — request body — body data client legal entity, Create a direct employee — request body — body data client team
Create a direct employee — request body — body data compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The compensation details of the employee |
currency | string | Required within parent | The currency of the salary Maximum length: 3 Minimum length: 3 |
salary | string | Required within parent | The salary of the employee |
scale | string | Optional | The scale at which the salary is paid Default: ANNUAL One of: ANNUAL, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY |
Create a direct employee — request body — body data employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The person that is being hired |
country | string | Required within parent | The country of the person being hired Maximum length: 2 Minimum length: 2 |
email | string | Required within parent | The personal email of the person being hired Format: email Maximum length: 255 Minimum length: 3 |
external_id | string | Optional | An external identifier for the person being hired |
first_name | string | Required within parent | The first name of the person being hired Maximum length: 100 Minimum length: 3 |
last_name | string | Required within parent | The last name of the person being hired Maximum length: 100 Minimum length: 3 |
nationality | string | Required within parent | The nationality of the person being hired Maximum length: 2 Minimum length: 2 |
state | string | Optional | The state of the person being hired Maximum length: 50 Minimum length: 1 |
work_email | string | Optional | The work email of the person being hired Format: email Maximum length: 255 Minimum length: 3 |
Create a direct employee — request body — body data employment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The employment details of the employee |
$ (oneOf 1) | Model | Alternative | Expand Create a direct employee — request body — body / data / employment / type: PART TIME |
$ (oneOf 2) | Model | Alternative | Expand Create a direct employee — request body — body / data / employment / type: FULL TIME |
Referenced models: Create a direct employee — request body — body / data / employment / type: PART TIME, Create a direct employee — request body — body / data / employment / type: FULL TIME
Create a direct employee — request body — body data invitation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Optional invitation configuration for the new hire. Defaults to 'IMMEDIATE' if not provided. |
action | string | Optional | Controls whether to send an invitation email. One of: DISABLE, IMMEDIATE |
Create a direct employee — 201 response body — data compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The compensation details of the employee |
currency | string | Required within parent | The currency of the salary Maximum length: 3 Minimum length: 3 |
salary | string | Required within parent | The salary of the employee |
scale | string | Optional | The scale at which the salary is paid Known values: ANNUAL, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY, HOURLY Default: ANNUAL |
Create a direct employee — 201 response body — data employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The person that is being hired |
email | string | Required within parent | The personal email of the person being hired Format: email Maximum length: 255 Minimum length: 3 |
external_id | string | Optional | An external identifier for the person being hired |
first_name | string | Required within parent | The first name of the person being hired Maximum length: 100 Minimum length: 3 |
last_name | string | Required within parent | The last name of the person being hired Maximum length: 100 Minimum length: 3 |
nationality | string | Required within parent | The nationality of the person being hired Maximum length: 2 Minimum length: 2 |
work_email | string | Optional | The work email of the person being hired Format: email Maximum length: 255 Minimum length: 3 |
Create a direct employee — request body — body data client department
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The department information for the employee |
id | string | Required within parent | The department that the employee is part of Format: uuid |
Create a direct employee — request body — body data client legal entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The legal entity information for the employee |
id | string | Required within parent | The legal entity that the employee is part of Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.people_createadirectemployee_v2026_01_01. Catalog operation: people_createadirectemployee_v2026_01_01. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["people:write"]
Pinned headers: {"X-Version": "2026-01-01"}