Deel: Get personal information by id
Deel personalInformation.getPersonPersonalInfo: arguments, response, policy and SDK examples.
← Personal information operations · Get started
Operation deel.personalinformation_getpersonpersonalinfo
Provider route: GET /people/{worker_id}/personal. 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["personalInformation"]["getPersonPersonalInfo"]>[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.personalInformation.getPersonPersonalInfo(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.personal_information.get_person_personal_info(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.worker_id | string | Required within parent |
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 personal information by id — 200 response body |
Referenced models: Get personal information by id — 200 response body
Schemas
Section titled “Schemas”8 more schemas are linked from the tables above, on the schema pages.
Get personal information by id — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get personal information by id — 200 response body — data |
Referenced models: Get personal information by id — 200 response body — data
Get personal information by id — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
addresses | JSON | Optional | |
addresses (anyOf 1) | array | Alternative | Array of addresses associated with the worker. |
addresses (anyOf 1)[] | Model | Each item | Expand Get personal information by id — 200 response body — data addresses Array of addresses associated with the worker item |
addresses (anyOf 2) | null | Alternative | Array of addresses associated with the worker. |
addresses (anyOf 2)[] | Model | Each item | Expand Get personal information by id — 200 response body — data addresses Array of addresses associated with the worker item |
date_of_birth | JSON | Optional | |
date_of_birth (anyOf 1) | string | Alternative | The date of birth of the worker. Format: date |
date_of_birth (anyOf 2) | null | Alternative | The date of birth of the worker. Format: date |
demographics | JSON | Optional | Demographic information for the worker, including gender and ethnicity. |
demographics (anyOf 1) | Model | Alternative | Expand Get personal information by id — 200 response body — data demographics ethnicity, gender |
demographics (anyOf 2) | null | Alternative | |
emergency_contacts | array | Required within parent | Array of emergency contacts associated with the worker. |
emergency_contacts[] | Model | Each item | Expand Get personal information by id — 200 response body — data emergency contacts item |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | The external id of the worker. Maximum length: 100 |
external_id (anyOf 2) | null | Alternative | The external id of the worker. Maximum length: 100 |
id | string | Required within parent | Unique identifier for the worker. Format: uuid |
kyc | Model | Optional | Expand Get personal information by id — 200 response body — data kyc KYC (Know Your Customer) verification information for the worker. |
legal_first_name | JSON | Optional | |
legal_first_name (anyOf 1) | string | Alternative | The legal first name of the worker. Maximum length: 100 |
legal_first_name (anyOf 2) | null | Alternative | The legal first name of the worker. Maximum length: 100 |
legal_last_name | JSON | Optional | |
legal_last_name (anyOf 1) | string | Alternative | The legal last name of the worker. Maximum length: 100 |
legal_last_name (anyOf 2) | null | Alternative | The legal last name of the worker. Maximum length: 100 |
nationalities | JSON | Optional | |
nationalities (anyOf 1) | array | Alternative | Array of nationalities associated with the worker. |
nationalities (anyOf 1)[] | Model | Each item | Expand Get personal information by id — 200 response body — data nationalities Array of nationalities associated with the worker item |
nationalities (anyOf 2) | null | Alternative | Array of nationalities associated with the worker. |
nationalities (anyOf 2)[] | Model | Each item | Expand Get personal information by id — 200 response body — data nationalities Array of nationalities associated with the worker item |
ooo | JSON | Optional | Out of office information for the worker, including leave type and dates. |
ooo (anyOf 1) | Model | Alternative | Expand Get personal information by id — 200 response body — data / ooo / leave_type: LONG TERM LEAVE, SHORT TERM LEAVE |
ooo (anyOf 2) | null | Alternative | |
personal_email | JSON | Optional | |
personal_email (anyOf 1) | string | Alternative | The personal email of the worker. Format: email Maximum length: 255 |
personal_email (anyOf 2) | null | Alternative | The personal email of the worker. Format: email Maximum length: 255 |
phone_numbers | JSON | Optional | |
phone_numbers (anyOf 1) | array | Alternative | Array of phone numbers associated with the worker. |
phone_numbers (anyOf 1)[] | Model | Each item | Expand Get personal information by id — 200 response body — data phone numbers Array of phone numbers associated with the worker item |
phone_numbers (anyOf 2) | null | Alternative | Array of phone numbers associated with the worker. |
phone_numbers (anyOf 2)[] | Model | Each item | Expand Get personal information by id — 200 response body — data phone numbers Array of phone numbers associated with the worker item |
preferred_name | JSON | Optional | |
preferred_name (anyOf 1) | string | Alternative | The preferred name of the worker. Maximum length: 255 |
preferred_name (anyOf 2) | null | Alternative | The preferred name of the worker. Maximum length: 255 |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | The work email of the worker. Format: email Maximum length: 255 |
work_email (anyOf 2) | null | Alternative | The work email of the worker. Format: email Maximum length: 255 |
worker_id | JSON | Required within parent | |
worker_id (anyOf 1) | integer | Alternative | The worker id. |
worker_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get personal information by id — 200 response body — data addresses Array of addresses associated with the worker item, Get personal information by id — 200 response body — data demographics ethnicity, gender, Get personal information by id — 200 response body — data emergency contacts item, Get personal information by id — 200 response body — data kyc, Get personal information by id — 200 response body — data nationalities Array of nationalities associated with the worker item, Get personal information by id — 200 response body — data / ooo / leave_type: LONG TERM LEAVE, SHORT TERM LEAVE, Get personal information by id — 200 response body — data phone numbers Array of phone numbers associated with the worker item
Get personal information by id — 200 response body — data addresses Array of addresses associated with the worker item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | The city. Maximum length: 255 |
city (anyOf 2) | null | Alternative | The city. Maximum length: 255 |
country | string | Required within parent | The country. Maximum length: 255 |
id | string | Required within parent | Unique identifier for the address. Format: uuid |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | The state. Maximum length: 255 |
state (anyOf 2) | null | Alternative | The state. Maximum length: 255 |
street | JSON | Required within parent | |
street (anyOf 1) | string | Alternative | The street address. Maximum length: 255 |
street (anyOf 2) | null | Alternative | The street address. Maximum length: 255 |
type | string | Required within parent | The type of the address. Known values: HOME, POSTAL, CONTRACT |
zip | JSON | Required within parent | |
zip (anyOf 1) | string | Alternative | The zip code. Maximum length: 255 |
zip (anyOf 2) | null | Alternative | The zip code. Maximum length: 255 |
Get personal information by id — 200 response body — data demographics ethnicity, gender
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Demographic information for the worker, including gender and ethnicity. |
ethnicity | JSON | Required within parent | Ethnicity information for the worker. |
ethnicity (anyOf 1) | Model | Alternative | Expand Get personal information by id — 200 response body — data demographics ethnicity, gender ethnicity Ethnicity information for the worker |
ethnicity (anyOf 2) | null | Alternative | |
gender | JSON | Required within parent | Gender information for the worker. |
gender (anyOf 1) | Model | Alternative | Expand Get personal information by id — 200 response body — data demographics ethnicity, gender gender Gender information for the worker |
gender (anyOf 2) | null | Alternative |
Referenced models: Get personal information by id — 200 response body — data demographics ethnicity, gender ethnicity Ethnicity information for the worker, Get personal information by id — 200 response body — data demographics ethnicity, gender gender Gender information for the worker
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.personalinformation_getpersonpersonalinfo. Catalog operation: personalinformation_getpersonpersonalinfo. 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"}