Deel: Get custom field from people by id
Deel customFieldsPeople.getPersonCustomField: arguments, response, policy and SDK examples.
← Custom fields people operations · Get started
Operation deel.customfieldspeople_getpersoncustomfield
Provider route: GET /people/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["customFieldsPeople"]["getPersonCustomField"]>[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.customFieldsPeople.getPersonCustomField(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_people.get_person_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 field from people by id — 200 response body |
Referenced models: Get custom field from people by id — 200 response body
Schemas
Section titled “Schemas”Get custom field from people by id — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get custom field from people by id — 200 response body — data |
Referenced models: Get custom field from people by id — 200 response body — data
Get custom field from people by id — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Creation date of the custom field Format: date |
description | string | 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 | Valid placements for custom field Known values: profile, contract |
settings | Model | Optional | Expand Get custom field from people by id — 200 response body — data settings |
type | Model | Optional | Expand Get custom field from people by id — 200 response body — data type |
Referenced models: Get custom field from people by id — 200 response body — data settings, Get custom field from people by id — 200 response body — data type
Get custom field from people by id — 200 response body — data settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
access | Model | Optional | Expand Get custom field from people by id — 200 response body — data settings access Access settings for the custom field |
countries | array | Optional | Countries for which the custom field is applicable. |
countries[] | string | Each item | |
is_enabled | boolean | Optional | Whether the custom field is enabled |
required | boolean | Optional | Whether the custom field is required |
worker_types | array | Optional | Worker types for which the custom field is applicable |
worker_types[] | string | Each item | Known values: eor, contractor, hris_direct_employee, direct_employee |
Referenced models: Get custom field from people by id — 200 response body — data settings access
Get custom field from people by id — 200 response body — data type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Get custom field from people by id — 200 response body — data / type / name: text, number, date, percentage |
$ (anyOf 2) | Model | Alternative | Expand Get custom field from people by id — 200 response body — data / type / name: currency |
$ (anyOf 3) | Model | Alternative | Expand Get custom field from people by id — 200 response body — data / type / name: list, multiselect |
Referenced models: Get custom field from people by id — 200 response body — data / type / name: text, number, date, percentage, Get custom field from people by id — 200 response body — data / type / name: currency, Get custom field from people by id — 200 response body — data / type / name: list, multiselect
Get custom field from people by id — 200 response body — data settings access
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Access settings for the custom field |
is_sensitive | boolean | Optional | Whether the custom field is sensitive |
provided_by | array | Optional | Entities providing access to the custom field |
provided_by[] | string | Each item | Known values: organization, worker |
Get custom field from people by id — 200 response body — data / type / name: text, number, date, percentage
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | Simple types Known values: text, number, date, percentage |
Get custom field from people by id — 200 response body — data / type / name: currency
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Currency code |
is_fixed | boolean | Optional | When currency is fixed, only the amount can be edited by the users |
name | string | Optional | Currency type Known values: currency |
Get custom field from people by id — 200 response body — data / type / name: list, multiselect
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | List types Known values: list, multiselect |
options | array | Optional | List of options for the custom field |
options[] | string | Each item |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.customfieldspeople_getpersoncustomfield. Catalog operation: customfieldspeople_getpersoncustomfield. 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: ["people:read"]
Pinned headers: {"X-Version": "2026-01-01"}