Skip to content

Deel: List all custom fields

Deel customFieldsContracts.listContractCustomFields: arguments, response, policy and SDK examples.

← Custom fields contracts operations · Get started

Operation deel.customfieldscontracts_listcontractcustomfields

Provider route: GET /contracts/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"]["listContractCustomFields"]>[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.listContractCustomFields(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.list_contract_custom_fields(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List all custom fields — 200 response body

Referenced models: List all custom fields — 200 response body

List all custom fields — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List all custom fields — 200 response body — data item

Referenced models: List all custom fields — 200 response body — data item

List all custom fields — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentCreation date of the custom field
Format: date-time
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the custom field
Maximum length: 140
description (anyOf 2)nullAlternativeDescription of the custom field
Maximum length: 140
idstringRequired within parentUnique identifier of the custom field
Format: uuid
namestringRequired within parentName of the custom field
placementJSONOptionalValid placements for custom field
placement (anyOf 1)stringAlternativeValid placements for custom field
Known values: profile, contract
placement (anyOf 2)nullAlternative
settingsModelRequired within parentExpand List all custom fields — 200 response body — data item settings
Configuration settings for the custom field including requirements, visibility, and access controls
typeModelRequired within parentExpand List all custom fields — 200 response body — data item type
Type configuration of the custom field including its data type and type-specific properties

Referenced models: List all custom fields — 200 response body — data item settings, List all custom fields — 200 response body — data item type

List all custom fields — 200 response body — data item settings
FieldTypePresenceDescription and constraints
$objectRootConfiguration settings for the custom field including requirements, visibility, and access controls
accessModelRequired within parentExpand List all custom fields — 200 response body — data item settings access
Access settings for the custom field
countriesarrayOptionalCountries for which the custom field is applicable. Omitted when applicable to all.
countries[]stringEach item
is_enabledbooleanRequired within parentWhether the custom field is enabled
requiredbooleanRequired within parentWhether the custom field is required
worker_typesarrayOptionalWorker types for which the custom field is applicable. Omitted when applicable to all.
worker_types[]stringEach itemKnown values: eor, contractor, hris_direct_employee, direct_employee

Referenced models: List all custom fields — 200 response body — data item settings access

List all custom fields — 200 response body — data item type
FieldTypePresenceDescription and constraints
$JSONRootType configuration of the custom field including its data type and type-specific properties
$ (anyOf 1)ModelAlternativeExpand List all custom fields — 200 response body — data / item / type / name: text, number, date, percentage, hyperlink
$ (anyOf 2)ModelAlternativeExpand List all custom fields — 200 response body — data / item / type / name: currency
$ (anyOf 3)ModelAlternativeExpand List all custom fields — 200 response body — data / item / type / name: list, multiselect

Referenced models: List all custom fields — 200 response body — data / item / type / name: text, number, date, percentage, hyperlink, List all custom fields — 200 response body — data / item / type / name: currency, List all custom fields — 200 response body — data / item / type / name: list, multiselect

List all custom fields — 200 response body — data item settings access
FieldTypePresenceDescription and constraints
$objectRootAccess settings for the custom field
group_permission_setJSONOptional
group_permission_set (anyOf 1)stringAlternativePermission set identifier for the custom field
group_permission_set (anyOf 2)nullAlternativePermission set identifier for the custom field
is_sensitivebooleanRequired within parentWhether the custom field is sensitive
provided_byJSONOptionalEntity providing access to the custom field
provided_by (anyOf 1)stringAlternativeEntity providing access to the custom field
Known values: organization, worker
provided_by (anyOf 2)nullAlternative
List all custom fields — 200 response body — data / item / type / name: text, number, date, percentage, hyperlink
FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentSimple types
Known values: text, number, date, percentage, hyperlink
List all custom fields — 200 response body — data / item / type / name: currency
FieldTypePresenceDescription and constraints
$objectRoot
currencyJSONOptional
currency (anyOf 1)stringAlternativeCurrency code (null when is_fixed is false)
Maximum length: 3
currency (anyOf 2)nullAlternativeCurrency code (null when is_fixed is false)
Maximum length: 3
is_fixedbooleanRequired within parentWhen currency is fixed, only the amount can be edited by the users
namestringRequired within parentCurrency type
Known values: currency
List all custom fields — 200 response body — data / item / type / name: list, multiselect
FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentList types
Known values: list, multiselect
optionsarrayRequired within parentList of options for the custom field
options[]stringEach item

SDK function policy ID: deel.customfieldscontracts_listcontractcustomfields. Catalog operation: customfieldscontracts_listcontractcustomfields. 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.