Skip to content

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.

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 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.global_payroll.create_gp_worker(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true
bodyobjectOptional
body.dataModelRequired within parentExpand Create a Global Payroll worker — request body — body data

Referenced models: Create a Global Payroll worker — 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 Global Payroll worker — 201 response body

Referenced models: Create a Global Payroll worker — 201 response body

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

Create a Global Payroll worker — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
compensationModelRequired within parentExpand Create a Global Payroll worker — request body — body data compensation
Base compensation of the worker.
contract_statestringOptionalState 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_numberstringOptionalEmployee 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_typestringRequired within parentEmployment type of the worker.
One of: FULL_TIME, PART_TIME
external_idstringOptionalIdentifier of the worker in your own system. It must be unique within your organization.
Maximum length: 100
Minimum length: 1
fte_percentageintegerOptionalFull-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_addressModelRequired within parentExpand Create a Global Payroll worker — request body — body data home address
Home address of the worker.
job_titlestringRequired within parentJob title of the worker.
Maximum length: 255
Minimum length: 1
legal_entity_idstringRequired within parentIdentifier 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_idstringRequired within parentIdentifier of the active Global Payroll payroll group of the legal entity the worker is paid in.
Maximum length: 100
Minimum length: 1
personal_infoModelRequired within parentExpand Create a Global Payroll worker — request body — body data personal info
Personal details of the worker.
ptoModelOptionalExpand Create a Global Payroll worker — request body — body data pto
Paid time off settings for the worker.
should_invite_employee_to_appbooleanOptionalWhether to email the worker an invitation to join Deel. Defaults to false.
Default: false
start_datestringRequired within parentEmployment start date, in YYYY-MM-DD format. The payroll start date defaults to it.
Format: date
Maximum length: 10
Minimum length: 10
team_idstringRequired within parentIdentifier 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_locationModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootBase compensation of the worker.
amountnumberRequired within parentBase compensation amount per scale period.
Format: double
Minimum: 0
currencystringRequired within parentISO 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}$
scalestringRequired within parentPeriod the amount is paid for.
One of: ANNUALLY, MONTHLY, BI_MONTHLY, TWO_WEEKLY, WEEKLY, DAILY, HOURLY
typestringOptionalWhether 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
FieldTypePresenceDescription and constraints
$objectRootHome address of the worker.
citystringRequired within parentCity.
Maximum length: 100
Minimum length: 1
countrystringRequired within parentCountry of the home address as an ISO 3166-1 alpha-2 code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
statestringOptionalState, province or region.
Maximum length: 50
Minimum length: 1
streetstringRequired within parentStreet and number.
Maximum length: 255
Minimum length: 1
zipstringRequired within parentPostal code.
Maximum length: 100
Minimum length: 1
Create a Global Payroll worker — request body — body data personal info
FieldTypePresenceDescription and constraints
$objectRootPersonal details of the worker.
date_of_birthstringOptionalDate of birth of the worker, in YYYY-MM-DD format.
Format: date
Maximum length: 10
Minimum length: 10
emailstringRequired within parentPersonal email address of the worker. It identifies the worker within your organization.
Format: email
Maximum length: 255
Minimum length: 3
first_namestringRequired within parentFirst name of the worker.
Maximum length: 100
Minimum length: 1
last_namestringRequired within parentLast name of the worker.
Maximum length: 100
Minimum length: 1
nationalitystringOptionalNationality of the worker as an ISO 3166-1 alpha-2 country code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
work_emailstringOptionalWork email address of the worker.
Format: email
Maximum length: 255
Minimum length: 3
Create a Global Payroll worker — request body — body data pto
FieldTypePresenceDescription and constraints
$objectRootPaid time off settings for the worker.
start_datestringOptionalDate paid time off starts accruing, in YYYY-MM-DD format.
Format: date
Maximum length: 10
Minimum length: 10
yearly_allowancenumberOptionalNumber of paid time off days granted per year.
Format: double
Minimum: 0
Create a Global Payroll worker — request body — body data work location
FieldTypePresenceDescription and constraints
$objectRootWhere the worker works. Required when the legal entity is in the United States.
effective_datestringOptionalDate from which the work location applies. Defaults to start_date.
Format: date
entity_address_idstringOptionalIdentifier 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_remotebooleanRequired within parentWhether the worker works remotely rather than from an entity office.
namestringOptionalName 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
FieldTypePresenceDescription and constraints
$objectRoot
legal_entityModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalCurrency of gross annual/month salary.
salaryJSONOptional
salary (anyOf 1)numberAlternativeGross annual/month salary.
Format: double
salary (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
scalestringOptionalScale at which the salary is paid.
Create a Global Payroll worker — 201 response body — data employee
FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalEmployee's email address.
employee_numberJSONOptional
employee_number (anyOf 1)stringAlternativeEmployee's number.
employee_number (anyOf 2)nullAlternativeEmployee's number.
first_namestringOptionalEmployee's first name.
idstringOptionalWorker id. Use it with the other Global Payroll worker endpoints (`/rest/gp/workers/{worker_id}/...`).
Format: uuid
last_namestringOptionalEmployee's last name.

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

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.