Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.dataModelRequired within parentExpand Create a direct employee — request body — body data

Referenced models: Create a direct employee — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a direct employee — 201 response body

Referenced models: Create a direct employee — 201 response body

4 more schemas are linked from the tables above, on the schema pages.

Create a direct employee — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
clientModelRequired within parentExpand Create a direct employee — request body — body data client
The entity that is hiring the employee
compensation_detailsModelRequired within parentExpand Create a direct employee — request body — body data compensation details
The compensation details of the employee
employeeModelRequired within parentExpand Create a direct employee — request body — body data employee
The person that is being hired
employmentModelRequired within parentExpand Create a direct employee — request body — body data employment
The employment details of the employee
invitationModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
compensation_detailsModelRequired within parentExpand Create a direct employee — 201 response body — data compensation details
The compensation details of the employee
employeeModelRequired within parentExpand Create a direct employee — 201 response body — data employee
The person that is being hired
employmentModelRequired within parentExpand Create a direct employee — 201 response body — data employment
The employment details of the employee
idstringRequired within parentThe 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
FieldTypePresenceDescription and constraints
$objectRootThe entity that is hiring the employee
departmentModelOptionalExpand Create a direct employee — request body — body data client department
The department information for the employee
legal_entityModelRequired within parentExpand Create a direct employee — request body — body data client legal entity
The legal entity information for the employee
teamModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootThe compensation details of the employee
currencystringRequired within parentThe currency of the salary
Maximum length: 3
Minimum length: 3
salarystringRequired within parentThe salary of the employee
scalestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootThe person that is being hired
countrystringRequired within parentThe country of the person being hired
Maximum length: 2
Minimum length: 2
emailstringRequired within parentThe personal email of the person being hired
Format: email
Maximum length: 255
Minimum length: 3
external_idstringOptionalAn external identifier for the person being hired
first_namestringRequired within parentThe first name of the person being hired
Maximum length: 100
Minimum length: 3
last_namestringRequired within parentThe last name of the person being hired
Maximum length: 100
Minimum length: 3
nationalitystringRequired within parentThe nationality of the person being hired
Maximum length: 2
Minimum length: 2
statestringOptionalThe state of the person being hired
Maximum length: 50
Minimum length: 1
work_emailstringOptionalThe work email of the person being hired
Format: email
Maximum length: 255
Minimum length: 3
Create a direct employee — request body — body data employment
FieldTypePresenceDescription and constraints
$JSONRootThe employment details of the employee
$ (oneOf 1)ModelAlternativeExpand Create a direct employee — request body — body / data / employment / type: PART TIME
$ (oneOf 2)ModelAlternativeExpand 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
FieldTypePresenceDescription and constraints
$objectRootOptional invitation configuration for the new hire. Defaults to 'IMMEDIATE' if not provided.
actionstringOptionalControls whether to send an invitation email.
One of: DISABLE, IMMEDIATE
Create a direct employee — 201 response body — data compensation details
FieldTypePresenceDescription and constraints
$objectRootThe compensation details of the employee
currencystringRequired within parentThe currency of the salary
Maximum length: 3
Minimum length: 3
salarystringRequired within parentThe salary of the employee
scalestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootThe person that is being hired
emailstringRequired within parentThe personal email of the person being hired
Format: email
Maximum length: 255
Minimum length: 3
external_idstringOptionalAn external identifier for the person being hired
first_namestringRequired within parentThe first name of the person being hired
Maximum length: 100
Minimum length: 3
last_namestringRequired within parentThe last name of the person being hired
Maximum length: 100
Minimum length: 3
nationalitystringRequired within parentThe nationality of the person being hired
Maximum length: 2
Minimum length: 2
work_emailstringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootThe department information for the employee
idstringRequired within parentThe department that the employee is part of
Format: uuid
Create a direct employee — request body — body data client legal entity
FieldTypePresenceDescription and constraints
$objectRootThe legal entity information for the employee
idstringRequired within parentThe legal entity that the employee is part of
Format: uuid

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.