Deel: List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User
List users: 200 response body, field Resources / item / 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: List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
birthday | string | Optional | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
customFields | JSON | Optional | |
customFields (anyOf 1) | array | Alternative | |
customFields (anyOf 1)[] | Model | Each item | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item |
customFields (anyOf 2) | null | Alternative | |
customFields (anyOf 2)[] | Model | Each item | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item |
departmentCustomFields | JSON | Optional | |
departmentCustomFields (anyOf 1) | object | Alternative | Org-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).* | string | Additional keys | |
departmentCustomFields (anyOf 2) | null | Alternative | Org-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).* | string | Additional keys | |
departmentExternalId | JSON | Optional | |
departmentExternalId (anyOf 1) | string | Alternative | |
departmentExternalId (anyOf 2) | null | Alternative | |
departmentExternalIdHierarchy | JSON | Optional | |
departmentExternalIdHierarchy (anyOf 1) | string | Alternative | |
departmentExternalIdHierarchy (anyOf 2) | null | Alternative | |
departmentHierarchy | JSON | Optional | |
departmentHierarchy (anyOf 1) | string | Alternative | |
departmentHierarchy (anyOf 2) | null | Alternative | |
employments | JSON | Optional | |
employments (anyOf 1) | array | Alternative | |
employments (anyOf 1)[] | Model | Each item | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item |
employments (anyOf 2) | null | Alternative | |
employments (anyOf 2)[] | Model | Each item | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item |
endDate | string | Optional | |
hiringStatus | string | Optional | |
isManager | boolean | Optional | Default: false |
jobProfile | JSON | Optional | Active 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) | Model | Alternative | Expand 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) | null | Alternative | |
organizationalStructures | array | Optional | |
organizationalStructures[] | Model | Each item | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures item |
preferredFirstName | string | Optional | |
preferredLastName | string | Optional | |
preferredName | string | Optional | |
startDate | JSON | Optional | |
startDate (anyOf 1) | string | Alternative | |
startDate (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | |
state (anyOf 2) | null | Alternative | |
workLocation | JSON | Optional | |
workLocation (anyOf 1) | string | Alternative | The work location label assigned to the worker’s HRIS profile |
workLocation (anyOf 2) | null | Alternative | The work location label assigned to the worker’s HRIS profile |
workerId | JSON | Optional | |
workerId (anyOf 1) | string | Alternative | |
workerId (anyOf 2) | null | Alternative | |
workerTerminationLastDateOfWork | JSON | Optional | |
workerTerminationLastDateOfWork (anyOf 1) | string | Alternative | |
workerTerminationLastDateOfWork (anyOf 2) | null | Alternative |
Referenced models: Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item, List users — 200 response body — Resources item 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 job Profile id, job Family, job Family Group, level, name, track, List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures item