Deel: Retrieve custom fields for a contract
Deel customFieldsContracts.getContractCustomFields: arguments, response, policy and SDK examples.
← Custom fields contracts operations · Get started
Operation deel.customfieldscontracts_getcontractcustomfields
Provider route: GET /contracts/{contract_id}/custom_fields. 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"]["getContractCustomFields"]>[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.getContractCustomFields(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_contract_custom_fields(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.contract_id | string | Required within parent |
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 custom fields for a worker — 200 response body |
Referenced models: Retrieve custom fields for a worker — 200 response body
Schemas
Section titled “Schemas”Retrieve custom fields for a worker — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve custom fields for a worker — 200 response body — data item |
Referenced models: Retrieve custom fields for a worker — 200 response body — data item
Retrieve custom fields for a worker — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve custom fields for a worker — 200 response body — data item data |
id | string | Required within parent | UUID for the custom field value Format: uuid |
name | string | Required within parent | Name of the custom field |
type | string | Required within parent | Type of the custom field Known values: text, number, currency, date, percentage, list, multiselect, hyperlink |
Referenced models: Retrieve custom fields for a worker — 200 response body — data item data
Retrieve custom fields for a worker — 200 response body — data item data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Retrieve custom fields for a worker — 200 response body — data item data Text type |
$ (anyOf 2) | Model | Alternative | Expand Retrieve custom fields for a worker — 200 response body — data item data Number type |
$ (anyOf 3) | Model | Alternative | Expand Retrieve custom fields for a worker — 200 response body — data / item / data / Date type: YYYY-MM-DD |
$ (anyOf 4) | Model | Alternative | Expand Retrieve custom fields for a worker — 200 response body — data item data Percentage type |
$ (anyOf 5) | Model | Alternative | Expand Retrieve custom fields for a worker — 200 response body — data item data Currency type |
$ (anyOf 6) | Model | Alternative | Expand Retrieve custom fields for a worker — 200 response body — data item data List type |
$ (anyOf 7) | Model | Alternative | Expand Retrieve custom fields for a worker — 200 response body — data item data Multiselect type |
Referenced models: Retrieve custom fields for a worker — 200 response body — data item data Text type, Retrieve custom fields for a worker — 200 response body — data / item / data / Date type: YYYY-MM-DD, Retrieve custom fields for a worker — 200 response body — data item data List type, Retrieve custom fields for a worker — 200 response body — data item data Multiselect type, Retrieve custom fields for a worker — 200 response body — data item data Number type, Retrieve custom fields for a worker — 200 response body — data item data Percentage type, Retrieve custom fields for a worker — 200 response body — data item data Currency type
Retrieve custom fields for a worker — 200 response body — data item data Text type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Text type |
value | string | Optional |
Retrieve custom fields for a worker — 200 response body — data / item / data / Date type: YYYY-MM-DD
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Date type: YYYY-MM-DD |
value | string | Optional | Format: date |
Retrieve custom fields for a worker — 200 response body — data item data List type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List type |
option | string | Optional |
Retrieve custom fields for a worker — 200 response body — data item data Multiselect type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Multiselect type |
options | array | Optional | |
options[] | string | Each item |
Retrieve custom fields for a worker — 200 response body — data item data Number type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Number type |
value | JSON | Optional | |
value (anyOf 1) | number | Alternative | Format: double |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve custom fields for a worker — 200 response body — data item data Percentage type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Percentage type |
text | string | Optional | |
value | JSON | Optional | |
value (anyOf 1) | number | Alternative | Format: double |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve custom fields for a worker — 200 response body — data item data Currency type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Currency type |
amount | JSON | Optional | |
amount (anyOf 1) | number | Alternative | Format: double |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Optional | The currency code in ISO 4217 format |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.customfieldscontracts_getcontractcustomfields. Catalog operation: customfieldscontracts_getcontractcustomfields. 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"}