Skip to content

Deel: Retrieve the Global Payroll worker creation schema

Deel globalPayroll.retrieveGpWorkerCreationSchema: arguments, response, policy and SDK examples.

← Global payroll operations · Get started

Operation deel.globalpayroll_retrievegpworkercreationschema_v2026_10_01

Provider route: GET /gp/workers/creation-schema. 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"]["retrieveGpWorkerCreationSchema"]>[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.retrieveGpWorkerCreationSchema(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.retrieve_gp_worker_creation_schema(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.countrystringOptionalMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
query.legal_entity_idstringOptionalFormat: uuid
Maximum length: 36
Minimum length: 36
query.payroll_group_idstringOptionalMaximum length: 100
Minimum length: 1
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve the Global Payroll worker creation schema — 200 response body

Referenced models: Retrieve the Global Payroll worker creation schema — 200 response body

Retrieve the Global Payroll worker creation schema — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentFields accepted by POST /rest/gp/workers. A field absent from the list is not accepted for the given country.
data[]ModelEach itemExpand Retrieve the Global Payroll worker creation schema — 200 response body — data item

Referenced models: Retrieve the Global Payroll worker creation schema — 200 response body — data item

Retrieve the Global Payroll worker creation schema — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
defaultJSONOptionalValue applied when the field is omitted.
dependenciesarrayOptionalOther fields this field is conditional on.
dependencies[]ModelEach itemExpand Retrieve the Global Payroll worker creation schema — 200 response body — data item dependencies item
is_nullablebooleanOptionalWhether null is an accepted value.
is_requiredbooleanRequired within parentWhether the field must be provided for the given country, legal entity and payroll group.
keystringRequired within parentField to send, exactly as the create endpoint accepts it. Dotted for nested objects.
Maximum length: 200
Minimum length: 1
typestringRequired within parentTransport type of the field.
Known values: string, number, boolean, object, array
validationarrayOptionalConstraints applied to the value.
validation[]ModelEach itemExpand Retrieve the Global Payroll worker creation schema — 200 response body — data item validation item
values_allowedarrayOptionalPermitted values, when the field is restricted to a fixed set. For contract_state these are the provinces of the country.
values_allowed[]JSONEach itemAny type

Referenced models: Retrieve the Global Payroll worker creation schema — 200 response body — data item dependencies item, Retrieve the Global Payroll worker creation schema — 200 response body — data item validation item

Retrieve the Global Payroll worker creation schema — 200 response body — data item dependencies item
FieldTypePresenceDescription and constraints
$objectRoot
equalsarrayOptionalValues of the referenced field that trigger the condition.
equals[]JSONEach itemAny type
fieldstringRequired within parentField this one depends on.
Maximum length: 200
Minimum length: 1
Retrieve the Global Payroll worker creation schema — 200 response body — data item validation item
FieldTypePresenceDescription and constraints
$objectRoot
fieldstringOptionalField this constraint is relative to, when the bound references another field.
Maximum length: 200
Minimum length: 1
messagestringOptionalError message the create endpoint returns when the constraint fails.
Maximum length: 500
Minimum length: 1
typestringRequired within parentConstraint name, e.g. pattern, max, length, format, not_allowed.
Maximum length: 50
Minimum length: 1
valueJSONOptionalConstraint argument, when the constraint is a literal.

SDK function policy ID: deel.globalpayroll_retrievegpworkercreationschema_v2026_10_01. Catalog operation: globalpayroll_retrievegpworkercreationschema_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:read"]

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.