Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.worker_idstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get personal information by id — 200 response body

Referenced models: Get personal information by id — 200 response body

8 more schemas are linked from the tables above, on the schema pages.

Get personal information by id — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
addressesJSONOptional
addresses (anyOf 1)arrayAlternativeArray of addresses associated with the worker.
addresses (anyOf 1)[]ModelEach itemExpand Get personal information by id — 200 response body — data addresses Array of addresses associated with the worker item
addresses (anyOf 2)nullAlternativeArray of addresses associated with the worker.
addresses (anyOf 2)[]ModelEach itemExpand Get personal information by id — 200 response body — data addresses Array of addresses associated with the worker item
date_of_birthJSONOptional
date_of_birth (anyOf 1)stringAlternativeThe date of birth of the worker.
Format: date
date_of_birth (anyOf 2)nullAlternativeThe date of birth of the worker.
Format: date
demographicsJSONOptionalDemographic information for the worker, including gender and ethnicity.
demographics (anyOf 1)ModelAlternativeExpand Get personal information by id — 200 response body — data demographics ethnicity, gender
demographics (anyOf 2)nullAlternative
emergency_contactsarrayRequired within parentArray of emergency contacts associated with the worker.
emergency_contacts[]ModelEach itemExpand Get personal information by id — 200 response body — data emergency contacts item
external_idJSONOptional
external_id (anyOf 1)stringAlternativeThe external id of the worker.
Maximum length: 100
external_id (anyOf 2)nullAlternativeThe external id of the worker.
Maximum length: 100
idstringRequired within parentUnique identifier for the worker.
Format: uuid
kycModelOptionalExpand Get personal information by id — 200 response body — data kyc
KYC (Know Your Customer) verification information for the worker.
legal_first_nameJSONOptional
legal_first_name (anyOf 1)stringAlternativeThe legal first name of the worker.
Maximum length: 100
legal_first_name (anyOf 2)nullAlternativeThe legal first name of the worker.
Maximum length: 100
legal_last_nameJSONOptional
legal_last_name (anyOf 1)stringAlternativeThe legal last name of the worker.
Maximum length: 100
legal_last_name (anyOf 2)nullAlternativeThe legal last name of the worker.
Maximum length: 100
nationalitiesJSONOptional
nationalities (anyOf 1)arrayAlternativeArray of nationalities associated with the worker.
nationalities (anyOf 1)[]ModelEach itemExpand Get personal information by id — 200 response body — data nationalities Array of nationalities associated with the worker item
nationalities (anyOf 2)nullAlternativeArray of nationalities associated with the worker.
nationalities (anyOf 2)[]ModelEach itemExpand Get personal information by id — 200 response body — data nationalities Array of nationalities associated with the worker item
oooJSONOptionalOut of office information for the worker, including leave type and dates.
ooo (anyOf 1)ModelAlternativeExpand Get personal information by id — 200 response body — data / ooo / leave_type: LONG TERM LEAVE, SHORT TERM LEAVE
ooo (anyOf 2)nullAlternative
personal_emailJSONOptional
personal_email (anyOf 1)stringAlternativeThe personal email of the worker.
Format: email
Maximum length: 255
personal_email (anyOf 2)nullAlternativeThe personal email of the worker.
Format: email
Maximum length: 255
phone_numbersJSONOptional
phone_numbers (anyOf 1)arrayAlternativeArray of phone numbers associated with the worker.
phone_numbers (anyOf 1)[]ModelEach itemExpand Get personal information by id — 200 response body — data phone numbers Array of phone numbers associated with the worker item
phone_numbers (anyOf 2)nullAlternativeArray of phone numbers associated with the worker.
phone_numbers (anyOf 2)[]ModelEach itemExpand Get personal information by id — 200 response body — data phone numbers Array of phone numbers associated with the worker item
preferred_nameJSONOptional
preferred_name (anyOf 1)stringAlternativeThe preferred name of the worker.
Maximum length: 255
preferred_name (anyOf 2)nullAlternativeThe preferred name of the worker.
Maximum length: 255
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email of the worker.
Format: email
Maximum length: 255
work_email (anyOf 2)nullAlternativeThe work email of the worker.
Format: email
Maximum length: 255
worker_idJSONRequired within parent
worker_id (anyOf 1)integerAlternativeThe worker id.
worker_id (anyOf 2)stringAlternativePattern: ^-?[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
FieldTypePresenceDescription and constraints
$objectRoot
cityJSONRequired within parent
city (anyOf 1)stringAlternativeThe city.
Maximum length: 255
city (anyOf 2)nullAlternativeThe city.
Maximum length: 255
countrystringRequired within parentThe country.
Maximum length: 255
idstringRequired within parentUnique identifier for the address.
Format: uuid
stateJSONRequired within parent
state (anyOf 1)stringAlternativeThe state.
Maximum length: 255
state (anyOf 2)nullAlternativeThe state.
Maximum length: 255
streetJSONRequired within parent
street (anyOf 1)stringAlternativeThe street address.
Maximum length: 255
street (anyOf 2)nullAlternativeThe street address.
Maximum length: 255
typestringRequired within parentThe type of the address.
Known values: HOME, POSTAL, CONTRACT
zipJSONRequired within parent
zip (anyOf 1)stringAlternativeThe zip code.
Maximum length: 255
zip (anyOf 2)nullAlternativeThe zip code.
Maximum length: 255
Get personal information by id — 200 response body — data demographics ethnicity, gender
FieldTypePresenceDescription and constraints
$objectRootDemographic information for the worker, including gender and ethnicity.
ethnicityJSONRequired within parentEthnicity information for the worker.
ethnicity (anyOf 1)ModelAlternativeExpand Get personal information by id — 200 response body — data demographics ethnicity, gender ethnicity Ethnicity information for the worker
ethnicity (anyOf 2)nullAlternative
genderJSONRequired within parentGender information for the worker.
gender (anyOf 1)ModelAlternativeExpand Get personal information by id — 200 response body — data demographics ethnicity, gender gender Gender information for the worker
gender (anyOf 2)nullAlternative

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

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"}

Official provider source

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.