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.
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"]["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 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.retrieve_gp_worker_creation_schema(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.country | string | Optional | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
query.legal_entity_id | string | Optional | Format: uuid Maximum length: 36 Minimum length: 36 |
query.payroll_group_id | string | Optional | Maximum length: 100 Minimum length: 1 |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
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 Retrieve the Global Payroll worker creation schema — 200 response body |
Referenced models: Retrieve the Global Payroll worker creation schema — 200 response body
Schemas
Section titled “Schemas”Retrieve the Global Payroll worker creation schema — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Fields accepted by POST /rest/gp/workers. A field absent from the list is not accepted for the given country. |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
default | JSON | Optional | Value applied when the field is omitted. |
dependencies | array | Optional | Other fields this field is conditional on. |
dependencies[] | Model | Each item | Expand Retrieve the Global Payroll worker creation schema — 200 response body — data item dependencies item |
is_nullable | boolean | Optional | Whether null is an accepted value. |
is_required | boolean | Required within parent | Whether the field must be provided for the given country, legal entity and payroll group. |
key | string | Required within parent | Field to send, exactly as the create endpoint accepts it. Dotted for nested objects. Maximum length: 200 Minimum length: 1 |
type | string | Required within parent | Transport type of the field. Known values: string, number, boolean, object, array |
validation | array | Optional | Constraints applied to the value. |
validation[] | Model | Each item | Expand Retrieve the Global Payroll worker creation schema — 200 response body — data item validation item |
values_allowed | array | Optional | Permitted values, when the field is restricted to a fixed set. For contract_state these are the provinces of the country. |
values_allowed[] | JSON | Each item | Any 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
equals | array | Optional | Values of the referenced field that trigger the condition. |
equals[] | JSON | Each item | Any type |
field | string | Required within parent | Field this one depends on. Maximum length: 200 Minimum length: 1 |
Retrieve the Global Payroll worker creation schema — 200 response body — data item validation item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field | string | Optional | Field this constraint is relative to, when the bound references another field. Maximum length: 200 Minimum length: 1 |
message | string | Optional | Error message the create endpoint returns when the constraint fails. Maximum length: 500 Minimum length: 1 |
type | string | Required within parent | Constraint name, e.g. pattern, max, length, format, not_allowed. Maximum length: 50 Minimum length: 1 |
value | JSON | Optional | Constraint argument, when the constraint is a literal. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}