Deel: Get custom fields from contracts
Deel customFieldsContracts.getCustomField: arguments, response, policy and SDK examples.
← Custom fields contracts operations · Get started
Operation deel.customfieldscontracts_getcustomfield
Provider route: GET /contracts/custom_fields/{id}. 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["customFieldsContracts"]["getCustomField"]>[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.customFieldsContracts.getCustomField(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.custom_fields_contracts.get_custom_field(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.id | string | Required within parent | Format: uuid |
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 Get custom fields from contracts — 200 response body |
Referenced models: Get custom fields from contracts — 200 response body
Schemas
Section titled “Schemas”Get custom fields from contracts — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response wrapper object |
data | Model | Required within parent | Expand Get custom fields from contracts — 200 response body — data Custom field object |
Referenced models: Get custom fields from contracts — 200 response body — data
Get custom fields from contracts — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Custom field object |
created_at | string | Optional | Creation timestamp Format: date-time |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Optional description of the custom field |
description (anyOf 2) | null | Alternative | Optional description of the custom field |
id | string | Optional | Custom field id Format: uuid |
name | string | Optional | Name of the custom field |
placement | string | Optional | Where the custom field is displayed Known values: profile, contract |
settings | Model | Optional | Expand Get custom fields from contracts — 200 response body — data settings Configuration settings for the custom field |
type | Model | Optional | Expand Get custom fields from contracts — 200 response body — data type Type definition of the custom field |
Referenced models: Get custom fields from contracts — 200 response body — data settings, Get custom fields from contracts — 200 response body — data type
Get custom fields from contracts — 200 response body — data settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Configuration settings for the custom field |
access | Model | Optional | Expand Get custom fields from contracts — 200 response body — data settings access Access control settings |
countries | array | Optional | Countries where the field applies |
countries[] | string | Each item | |
is_enabled | boolean | Optional | Whether the field is enabled |
required | boolean | Optional | Whether the field is mandatory |
worker_types | array | Optional | Applicable worker types |
worker_types[] | string | Each item | Worker type Known values: eor, contractor, hris_direct_employee, direct_employee |
Referenced models: Get custom fields from contracts — 200 response body — data settings access
Get custom fields from contracts — 200 response body — data type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Type definition of the custom field |
$ (anyOf 1) | Model | Alternative | Expand Get custom fields from contracts — 200 response body — data / type / name: text, number, date, percentage, hyperlink |
$ (anyOf 2) | Model | Alternative | Expand Get custom fields from contracts — 200 response body — data / type / name: currency |
$ (anyOf 3) | Model | Alternative | Expand Get custom fields from contracts — 200 response body — data / type / name: list, multiselect |
Referenced models: Get custom fields from contracts — 200 response body — data / type / name: text, number, date, percentage, hyperlink, Get custom fields from contracts — 200 response body — data / type / name: currency, Get custom fields from contracts — 200 response body — data / type / name: list, multiselect
Get custom fields from contracts — 200 response body — data settings access
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Access control settings |
is_sensitive | boolean | Optional | Whether the field contains sensitive data |
provided_by | JSON | Optional | Entity providing access |
provided_by (anyOf 1) | string | Alternative | Entity providing access Known values: organization, worker |
provided_by (anyOf 2) | null | Alternative |
Get custom fields from contracts — 200 response body — data / type / name: text, number, date, percentage, hyperlink
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Simple custom field types |
name | string | Optional | Simple field type Known values: text, number, date, percentage, hyperlink |
Get custom fields from contracts — 200 response body — data / type / name: currency
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Currency custom field type |
currency | string | Optional | ISO currency code |
is_fixed | boolean | Optional | Whether the currency is fixed |
name | string | Optional | Currency field type Known values: currency |
Get custom fields from contracts — 200 response body — data / type / name: list, multiselect
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List or multiselect custom field type |
name | string | Optional | List field type Known values: list, multiselect |
options | array | Optional | Available options for the list field |
options[] | string | Each item |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.customfieldscontracts_getcustomfield. Catalog operation: customfieldscontracts_getcustomfield. 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-01-01"}