Skip to content

Deel: List all people custom fields — 200 response body — data item settings

List all people custom fields: 200 response body, field data / item / settings. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: List all people custom fields — 200 response body — data item settings

FieldTypePresenceDescription and constraints
$objectRootSettings for the custom field
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.
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
worker_types[]stringEach itemKnown values: eor, peo, contractor, hris_direct_employee, hris_direct_contractor, direct_employee, contractor_outside_deel, person_without_contract

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

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.