Skip to content

Deel: Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User

Retrieve a single User: 200 response body, field urn:ietf:params:scim:schemas:extension:2.0:User. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User

FieldTypePresenceDescription and constraints
$objectRoot
countryJSONOptional
country (anyOf 1)stringAlternative
country (anyOf 2)nullAlternative
customFieldsJSONOptional
customFields (anyOf 1)arrayAlternative
customFields (anyOf 1)[]ModelEach itemExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item
customFields (anyOf 2)nullAlternative
customFields (anyOf 2)[]ModelEach itemExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item
customFieldsFlattenedJSONOptional
customFieldsFlattened (anyOf 1)objectAlternativeCustom fields keyed by field UUID. Only present when the scimFlattenedFields feature flag is enabled.
Additional keys: see wildcard field
customFieldsFlattened (anyOf 1).*ModelAdditional keysExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields Flattened null value
customFieldsFlattened (anyOf 2)nullAlternativeCustom fields keyed by field UUID. Only present when the scimFlattenedFields feature flag is enabled.
Additional keys: see wildcard field
customFieldsFlattened (anyOf 2).*ModelAdditional keysExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields Flattened null value
departmentCustomFieldsJSONOptional
departmentCustomFields (anyOf 1)objectAlternativeOrg-structure custom fields resolved for the department node, keyed by normalized field name. Only present when the department custom fields feature flag is enabled for the organization.
Additional keys: see wildcard field
departmentCustomFields (anyOf 1).*stringAdditional keys
departmentCustomFields (anyOf 2)nullAlternativeOrg-structure custom fields resolved for the department node, keyed by normalized field name. Only present when the department custom fields feature flag is enabled for the organization.
Additional keys: see wildcard field
departmentCustomFields (anyOf 2).*stringAdditional keys
departmentExternalIdJSONOptional
departmentExternalId (anyOf 1)stringAlternative
departmentExternalId (anyOf 2)nullAlternative
departmentExternalIdHierarchyJSONOptional
departmentExternalIdHierarchy (anyOf 1)stringAlternative
departmentExternalIdHierarchy (anyOf 2)nullAlternative
departmentHierarchyJSONOptional
departmentHierarchy (anyOf 1)stringAlternative
departmentHierarchy (anyOf 2)nullAlternative
employmentsJSONOptional
employments (anyOf 1)arrayAlternative
employments (anyOf 1)[]ModelEach itemExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item
employments (anyOf 2)nullAlternative
employments (anyOf 2)[]ModelEach itemExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item
endDateModelOptionalExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User end Date
hiringStatusstringOptional
isManagerbooleanOptionalDefault: false
jobProfileJSONOptionalActive job profile of the worker from job architecture. Present only when job profiles are enabled for the organization and job architecture is set up; null when the worker has no active job profile or the token lacks the job_profile.view permission.
jobProfile (anyOf 1)ModelAlternativeExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track
jobProfile (anyOf 2)nullAlternative
organizationalStructuresFlattenedJSONOptional
organizationalStructuresFlattened (anyOf 1)objectAlternativeOrg structures keyed by structure UUID. Only present when the scimFlattenedFields feature flag is enabled.
Additional keys: see wildcard field
organizationalStructuresFlattened (anyOf 1).*ModelAdditional keysExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures Flattened null value
organizationalStructuresFlattened (anyOf 2)nullAlternativeOrg structures keyed by structure UUID. Only present when the scimFlattenedFields feature flag is enabled.
Additional keys: see wildcard field
organizationalStructuresFlattened (anyOf 2).*ModelAdditional keysExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures Flattened null value
startDateJSONOptional
startDate (anyOf 1)stringAlternativeFormat: date
startDate (anyOf 2)nullAlternativeFormat: date
stateJSONOptional
state (anyOf 1)stringAlternative
state (anyOf 2)nullAlternative
workLocationJSONOptional
workLocation (anyOf 1)stringAlternativeThe work location label assigned to the worker’s HRIS profile
workLocation (anyOf 2)nullAlternativeThe work location label assigned to the worker’s HRIS profile

Referenced models: Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields Flattened null value, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User end Date, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures Flattened null value

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.