Deel: Create a Global Payroll worker
Deel globalPayroll.createGpWorker: arguments, response, policy and SDK examples.
← Global payroll operations · Get started
Operation deel.globalpayroll_creategpworker_v2026_10_01
Provider route: POST /gp/workers. 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["globalPayroll"]["createGpWorker"]>[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.globalPayroll.createGpWorker(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.global_payroll.create_gp_worker(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
body | object | Optional | |
body.data | Model | Required within parent | Expand Create a Global Payroll worker — request body — body data |
Referenced models: Create a Global Payroll worker — 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 Global Payroll worker — 201 response body |
Referenced models: Create a Global Payroll worker — 201 response body
Schemas
Section titled “Schemas”4 more schemas are linked from the tables above, on the schema pages.
Create a Global Payroll worker — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
compensation | Model | Required within parent | Expand Create a Global Payroll worker — request body — body data compensation Base compensation of the worker. |
contract_state | string | Optional | State or province code the contract is governed by. Required when the legal entity country has provinces enabled for Global Payroll (for example CA, US, AU, BR, IN) and must be one of its provinces. Maximum length: 50 Minimum length: 1 |
employee_number | string | Optional | Employee number in your payroll system. Required when the payroll group is a Payroll Connect (Soft GP) group. It must be unique within the legal entity. Maximum length: 100 Minimum length: 1 |
employment_type | string | Required within parent | Employment type of the worker. One of: FULL_TIME, PART_TIME |
external_id | string | Optional | Identifier of the worker in your own system. It must be unique within your organization. Maximum length: 100 Minimum length: 1 |
fte_percentage | integer | Optional | Full-time equivalent percentage, from 1 to 99. Required when employment_type is PART_TIME and not allowed when it is FULL_TIME. Maximum: 99 Minimum: 1 |
home_address | Model | Required within parent | Expand Create a Global Payroll worker — request body — body data home address Home address of the worker. |
job_title | string | Required within parent | Job title of the worker. Maximum length: 255 Minimum length: 1 |
legal_entity_id | string | Required within parent | Identifier of the Global Payroll legal entity the worker is employed by. It must belong to your organization. Format: uuid Maximum length: 36 Minimum length: 36 |
payroll_group_id | string | Required within parent | Identifier of the active Global Payroll payroll group of the legal entity the worker is paid in. Maximum length: 100 Minimum length: 1 |
personal_info | Model | Required within parent | Expand Create a Global Payroll worker — request body — body data personal info Personal details of the worker. |
pto | Model | Optional | Expand Create a Global Payroll worker — request body — body data pto Paid time off settings for the worker. |
should_invite_employee_to_app | boolean | Optional | Whether to email the worker an invitation to join Deel. Defaults to false. Default: false |
start_date | string | Required within parent | Employment start date, in YYYY-MM-DD format. The payroll start date defaults to it. Format: date Maximum length: 10 Minimum length: 10 |
team_id | string | Required within parent | Identifier of the team the contract is created in. It must belong to your organization and the caller needs permission to create contracts in it. Format: uuid Maximum length: 36 Minimum length: 36 |
work_location | Model | Optional | Expand Create a Global Payroll worker — request body — body data work location Where the worker works. Required when the legal entity is in the United States. |
Referenced models: Create a Global Payroll worker — request body — body data compensation, Create a Global Payroll worker — request body — body data home address, Create a Global Payroll worker — request body — body data personal info, Create a Global Payroll worker — request body — body data pto, Create a Global Payroll worker — request body — body data work location
Create a Global Payroll worker — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a Global Payroll worker — 201 response body — data |
Referenced models: Create a Global Payroll worker — 201 response body — data
Create a Global Payroll worker — request body — body data compensation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Base compensation of the worker. |
amount | number | Required within parent | Base compensation amount per scale period. Format: double Minimum: 0 |
currency | string | Required within parent | ISO 4217 currency code. It must be one of the currencies allowed for the legal entity country. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
scale | string | Required within parent | Period the amount is paid for. One of: ANNUALLY, MONTHLY, BI_MONTHLY, TWO_WEEKLY, WEEKLY, DAILY, HOURLY |
type | string | Optional | Whether the worker is salaried or paid hourly. Defaults to SALARIED. Default: SALARIED One of: SALARIED, HOURLY |
Create a Global Payroll worker — request body — body data home address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Home address of the worker. |
city | string | Required within parent | City. Maximum length: 100 Minimum length: 1 |
country | string | Required within parent | Country of the home address as an ISO 3166-1 alpha-2 code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
state | string | Optional | State, province or region. Maximum length: 50 Minimum length: 1 |
street | string | Required within parent | Street and number. Maximum length: 255 Minimum length: 1 |
zip | string | Required within parent | Postal code. Maximum length: 100 Minimum length: 1 |
Create a Global Payroll worker — request body — body data personal info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Personal details of the worker. |
date_of_birth | string | Optional | Date of birth of the worker, in YYYY-MM-DD format. Format: date Maximum length: 10 Minimum length: 10 |
email | string | Required within parent | Personal email address of the worker. It identifies the worker within your organization. Format: email Maximum length: 255 Minimum length: 3 |
first_name | string | Required within parent | First name of the worker. Maximum length: 100 Minimum length: 1 |
last_name | string | Required within parent | Last name of the worker. Maximum length: 100 Minimum length: 1 |
nationality | string | Optional | Nationality of the worker as an ISO 3166-1 alpha-2 country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
work_email | string | Optional | Work email address of the worker. Format: email Maximum length: 255 Minimum length: 3 |
Create a Global Payroll worker — request body — body data pto
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paid time off settings for the worker. |
start_date | string | Optional | Date paid time off starts accruing, in YYYY-MM-DD format. Format: date Maximum length: 10 Minimum length: 10 |
yearly_allowance | number | Optional | Number of paid time off days granted per year. Format: double Minimum: 0 |
Create a Global Payroll worker — request body — body data work location
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Where the worker works. Required when the legal entity is in the United States. |
effective_date | string | Optional | Date from which the work location applies. Defaults to start_date. Format: date |
entity_address_id | string | Optional | Identifier of an active address of the legal entity. When is_remote is false, provide either this or name. Format: uuid Maximum length: 36 Minimum length: 36 |
is_remote | boolean | Required within parent | Whether the worker works remotely rather than from an entity office. |
name | string | Optional | Name of an active address of the legal entity, as shown in the app. Alternative to entity_address_id when is_remote is false. 'Remote' is accepted and means a remote worker. Maximum length: 255 Minimum length: 1 |
Create a Global Payroll worker — 201 response body — data client
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
legal_entity | Model | Optional | Expand Create a Global Payroll worker — 201 response body — data client legal entity |
Referenced models: Create a Global Payroll worker — 201 response body — data client legal entity
Create a Global Payroll worker — 201 response body — data compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Currency of gross annual/month salary. |
salary | JSON | Optional | |
salary (anyOf 1) | number | Alternative | Gross annual/month salary. Format: double |
salary (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
scale | string | Optional | Scale at which the salary is paid. |
Create a Global Payroll worker — 201 response body — data employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | Employee's email address. |
employee_number | JSON | Optional | |
employee_number (anyOf 1) | string | Alternative | Employee's number. |
employee_number (anyOf 2) | null | Alternative | Employee's number. |
first_name | string | Optional | Employee's first name. |
id | string | Optional | Worker id. Use it with the other Global Payroll worker endpoints (`/rest/gp/workers/{worker_id}/...`). Format: uuid |
last_name | string | Optional | Employee's last name. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.globalpayroll_creategpworker_v2026_10_01. Catalog operation: globalpayroll_creategpworker_v2026_10_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: ["contracts:write"]
Pinned headers: {"X-Version": "2026-10-01"}