Deel: Retrieve a single person
Deel people.getPersonById: arguments, response, policy and SDK examples.
← People operations · Get started
Operation deel.people_getpersonbyid
Provider route: GET /people/{hris_profile_id}. 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["people"]["getPersonById"]>[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.people.getPersonById(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.people.get_person_by_id(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.hris_profile_id | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.include_custom_fields | boolean | Optional | |
query.include_worker_relations | boolean | Optional |
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 Retrieve a single person — 200 response body |
Referenced models: Retrieve a single person — 200 response body
Schemas
Section titled “Schemas”19 more schemas are linked from the tables above, on the schema pages.
Retrieve a single person — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve a single person — 200 response body — data |
Referenced models: Retrieve a single person — 200 response body — data
Retrieve a single person — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active_worker_termination_status | JSON | Optional | The status of the active worker termination. |
active_worker_termination_status (anyOf 1) | string | Alternative | The status of the active worker termination. Known values: PENDING, CONTRACT_TERMINATION_DATA_COLLECTED, IN_PROGRESS, COMPLETED, FAILED, CANCELED |
active_worker_termination_status (anyOf 2) | null | Alternative | |
additional_details | JSON | Optional | |
additional_details (anyOf 1) | array | Alternative | Country-scoped additional employment data points (national IDs, tax IDs, etc.) sourced from hris_employment_eligibility.eligibility_data. Returned only when the caller's organization has the feature flag enabled and the request is not redacting PII. |
additional_details (anyOf 1)[] | Model | Each item | Expand Retrieve a single person — 200 response body — data additional details null item |
additional_details (anyOf 2) | null | Alternative | Country-scoped additional employment data points (national IDs, tax IDs, etc.) sourced from hris_employment_eligibility.eligibility_data. Returned only when the caller's organization has the feature flag enabled and the request is not redacting PII. |
additional_details (anyOf 2)[] | Model | Each item | Expand Retrieve a single person — 200 response body — data additional details null item |
addresses | array | Optional | An array of address objects containing the employee's physical addresses. |
addresses[] | Model | Each item | Expand Retrieve a single person — 200 response body — data addresses item |
birth_date | JSON | Optional | |
birth_date (anyOf 1) | string | Alternative | The birth date of the employee. |
birth_date (anyOf 2) | null | Alternative | The birth date of the employee. |
client_legal_entity | Model | Optional | Expand Retrieve a single person — 200 response body — data client legal entity The primary client legal entity associated with the employee. |
completion_date | JSON | Optional | |
completion_date (anyOf 1) | string | Alternative | The completion date of the task or project. |
completion_date (anyOf 2) | null | Alternative | The completion date of the task or project. |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | The country of the employee. |
country (anyOf 2) | null | Alternative | The country of the employee. |
created_at | string | Optional | The creation timestamp of the employee record. Format: date-time |
custom_fields | array | Optional | An array of custom field objects containing additional attributes associated with the employee (e.g., Job title, Project code, etc.). |
custom_fields[] | Model | Each item | Expand Retrieve a single person — 200 response body — data custom fields item |
department | Model | Optional | Expand Retrieve a single person — 200 response body — data department The department of the employee. |
direct_employee_termination_last_day | string | Optional | The last day of work mentioned on the primary contract termination. Format: date |
direct_manager | JSON | Optional | The direct manager of the employee. |
direct_manager (anyOf 1) | Model | Alternative | Expand Retrieve a single person — 200 response body — data direct manager The direct manager of the employee |
direct_manager (anyOf 2) | null | Alternative | |
direct_reports | JSON | Optional | |
direct_reports (anyOf 1) | array | Alternative | The direct reports to the employee. |
direct_reports (anyOf 1)[] | Model | Each item | Expand Retrieve a single person — 200 response body — data direct reports The direct reports to the employee item |
direct_reports (anyOf 2) | null | Alternative | The direct reports to the employee. |
direct_reports (anyOf 2)[] | Model | Each item | Expand Retrieve a single person — 200 response body — data direct reports The direct reports to the employee item |
direct_reports_count | JSON | Optional | |
direct_reports_count (anyOf 1) | integer | Alternative | The count of direct reports to the employee. |
direct_reports_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
emails | array | Optional | An array of the employee's email addresses. |
emails[] | Model | Each item | Expand Retrieve a single person — 200 response body — data emails item |
employments | array | Optional | An array of employment records associated with the employee, including contract details, team information, payment details, and employment status. |
employments[] | Model | Each item | Expand Retrieve a single person — 200 response body — data employments item |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | The external ID of the employee. |
external_id (anyOf 2) | null | Alternative | The external ID of the employee. |
first_name | string | Optional | The first name of the employee. |
full_name | string | Optional | The full name of the employee. |
hiring_status | string | Optional | The current hiring status of the employee. |
hiring_type | string | Optional | The type of hiring of the employee. |
id | string | Optional | Unique identifier for the employee. Format: uuid |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | The job title of the employee. |
job_title (anyOf 2) | null | Alternative | The job title of the employee. |
last_name | string | Optional | The last name of the employee. |
nationalities | array | Optional | The nationality of the employee. |
nationalities[] | string | Each item | |
new_hiring_status | string | Optional | The new hiring status of the employee. |
preferred_first_name | JSON | Optional | |
preferred_first_name (anyOf 1) | string | Alternative | The preferred first name of the employee. |
preferred_first_name (anyOf 2) | null | Alternative | The preferred first name of the employee. |
preferred_last_name | JSON | Optional | |
preferred_last_name (anyOf 1) | string | Alternative | The preferred last name of the employee. |
preferred_last_name (anyOf 2) | null | Alternative | The preferred last name of the employee. |
profile_organizational_structures | array | Optional | An array of organizational structures associated with the employee profile. |
profile_organizational_structures[] | Model | Each item | Expand Retrieve a single person — 200 response body — data profile organizational structures item |
seniority | JSON | Optional | |
seniority (anyOf 1) | string | Alternative | The seniority level of the employee. |
seniority (anyOf 2) | null | Alternative | The seniority level of the employee. |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The date the employee started working. Format: date |
start_date (anyOf 2) | null | Alternative | The date the employee started working. Format: date |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | The state of the employee. |
state (anyOf 2) | null | Alternative | The state of the employee. |
timezone | JSON | Optional | |
timezone (anyOf 1) | string | Alternative | The timezone of the employee. |
timezone (anyOf 2) | null | Alternative | The timezone of the employee. |
updated_at | JSON | Optional | |
updated_at (anyOf 1) | string | Alternative | Long date-time format following ISO-8601 Format: date-time |
updated_at (anyOf 2) | null | Alternative | Long date-time format following ISO-8601 Format: date-time |
work_location | JSON | Optional | |
work_location (anyOf 1) | string | Alternative | The work location of the employee. |
work_location (anyOf 2) | null | Alternative | The work location of the employee. |
worker_id | string | Optional | The worker ID of the employee. |
Referenced models: Retrieve a single person — 200 response body — data additional details null item, Retrieve a single person — 200 response body — data client legal entity, Retrieve a single person — 200 response body — data addresses item, Retrieve a single person — 200 response body — data custom fields item, Retrieve a single person — 200 response body — data department, Retrieve a single person — 200 response body — data direct manager The direct manager of the employee, Retrieve a single person — 200 response body — data direct reports The direct reports to the employee item, Retrieve a single person — 200 response body — data emails item, Retrieve a single person — 200 response body — data employments item, Retrieve a single person — 200 response body — data profile organizational structures item
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.people_getpersonbyid. Catalog operation: people_getpersonbyid. 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"}