Skip to content

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.

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 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.custom_fields_contracts.get_contract_custom_fields(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parent

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve custom fields for a worker — 200 response body

Referenced models: Retrieve custom fields for a worker — 200 response body

Retrieve custom fields for a worker — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve custom fields for a worker — 200 response body — data item data
idstringRequired within parentUUID for the custom field value
Format: uuid
namestringRequired within parentName of the custom field
typestringRequired within parentType 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
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Retrieve custom fields for a worker — 200 response body — data item data Text type
$ (anyOf 2)ModelAlternativeExpand Retrieve custom fields for a worker — 200 response body — data item data Number type
$ (anyOf 3)ModelAlternativeExpand Retrieve custom fields for a worker — 200 response body — data / item / data / Date type: YYYY-MM-DD
$ (anyOf 4)ModelAlternativeExpand Retrieve custom fields for a worker — 200 response body — data item data Percentage type
$ (anyOf 5)ModelAlternativeExpand Retrieve custom fields for a worker — 200 response body — data item data Currency type
$ (anyOf 6)ModelAlternativeExpand Retrieve custom fields for a worker — 200 response body — data item data List type
$ (anyOf 7)ModelAlternativeExpand 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
FieldTypePresenceDescription and constraints
$objectRootText type
valuestringOptional
Retrieve custom fields for a worker — 200 response body — data / item / data / Date type: YYYY-MM-DD
FieldTypePresenceDescription and constraints
$objectRootDate type: YYYY-MM-DD
valuestringOptionalFormat: date
Retrieve custom fields for a worker — 200 response body — data item data List type
FieldTypePresenceDescription and constraints
$objectRootList type
optionstringOptional
Retrieve custom fields for a worker — 200 response body — data item data Multiselect type
FieldTypePresenceDescription and constraints
$objectRootMultiselect type
optionsarrayOptional
options[]stringEach item
Retrieve custom fields for a worker — 200 response body — data item data Number type
FieldTypePresenceDescription and constraints
$objectRootNumber type
valueJSONOptional
value (anyOf 1)numberAlternativeFormat: double
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Retrieve custom fields for a worker — 200 response body — data item data Percentage type
FieldTypePresenceDescription and constraints
$objectRootPercentage type
textstringOptional
valueJSONOptional
value (anyOf 1)numberAlternativeFormat: double
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Retrieve custom fields for a worker — 200 response body — data item data Currency type
FieldTypePresenceDescription and constraints
$objectRootCurrency type
amountJSONOptional
amount (anyOf 1)numberAlternativeFormat: double
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringOptionalThe currency code in ISO 4217 format

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

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.