Skip to content

Deel: List of People

Deel people.getPeople: arguments, response, policy and SDK examples.

← People operations · Get started

Operation deel.people_getpeople

Provider route: GET /people. 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["people"]["getPeople"]>[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.getPeople(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.people.get_people(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.offsetintegerOptionalDefault: 0
Maximum: 999999999
Minimum: 0
query.limitintegerOptionalMaximum: 200
Minimum: 1
query.searchstringOptional
query.teamsarrayOptional
query.teams[]stringEach itemFormat: uuid
query.fieldsarrayOptional
query.fields[]ModelEach itemExpand List of People — request body — query fields item
query.sort_bystringOptionalOne of: id, first_name, last_name, full_name, email, country, birth_date, hiring_type, start_date, team, job_title, hiring_status, completion_date, direct_manager, direct_reports_count, band_placement, comparative_ratio
query.sort_orderstringOptionalOne of: asc, desc
query.hiring_statusesarrayOptional
query.hiring_statuses[]stringEach itemOne of: pending_invite, draft, invited, onboarding, onboarding_at_risk, onboarding_overdue, onboarded, offboarding, active, inactive, in_review, quote_requires_changes
query.band_placementsarrayOptional
query.band_placements[]stringEach itemOne of: ABOVE, WITHIN, BELOW
query.comparative_ratios_fromstringOptional
query.comparative_ratios_tostringOptional
query.hiring_typesarrayOptional
query.hiring_types[]stringEach itemOne of: contractor, eor, peo, hris_direct_employee, hris_direct_contractor, direct_employee, contractor_outside_deel, person_without_contract
query.person_statusesarrayOptional
query.person_statuses[]stringEach itemOne of: ACTIVE, NOT_STARTED, INACTIVE

Referenced models: List of People — request body — query fields item

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List of People — 200 response body

Referenced models: List of People — 200 response body

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

List of People — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List of People — 200 response body — data item
pageModelOptionalExpand List of People — 200 response body — page

Referenced models: List of People — 200 response body — data item, List of People — 200 response body — page

List of People — request body — query fields item
FieldTypePresenceDescription and constraints
$stringRootOne of: id, created_at, first_name, last_name, full_name, preferred_first_name, preferred_last_name, worker_id, external_id, hris_organization_user_id, termination_last_day, worker_relations, custom_field_values, emails, birth_date, start_date, nationalities, client_legal_entity, state, seniority, completion_date, direct_manager, direct_reports, direct_reports_count, employments, employments[0].id, employments[0].name, employments[0].team, employments[0].custom_field_values, employments[0].email, employments[0].state, employments[0].country, employments[0].payment, employments[0].is_ended, employments[0].termination_last_day, employments[0].timezone, employments[0].job_title, employments[0].seniority, employments[0].start_date, employments[0].work_email, employments[0].hiring_type, employments[0].hiring_status, employments[0].completion_date, employments[0].contract_status, employments[0].voluntarily_left, employments[0].contract_coverage, employments[0].new_hiring_status, employments[0].client_legal_entity, employments[0].has_eor_termination, employments[0].contract_is_archived, employments[0].contract_has_contractor, employments[0].is_user_contract_deleted, employments[0].hris_direct_employee_invitation, employments[0].employee_number, hiring_status, new_hiring_status, is_pwac, hiring_type, job_title, country, timezone, department, work_location, updated_at, addresses, additional_details, profile_organizational_structures, worker_termination_last_date_of_work, active_worker_termination_status, last_day_of_work_local_date, person_status
List of People — 200 response body — page
FieldTypePresenceDescription and constraints
$objectRoot
items_per_pageJSONRequired within parent
items_per_page (anyOf 1)numberAlternativeFormat: double
Maximum: 200
Minimum: 1
items_per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetJSONRequired within parent
offset (anyOf 1)integerAlternativeMaximum: 999999999
Minimum: 0
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_rowsJSONRequired within parent
total_rows (anyOf 1)numberAlternativeFormat: double
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Retrieve a single person — 200 response body — data additional details null item
FieldTypePresenceDescription and constraints
$objectRoot
countrystringOptionalISO-2 country code that scopes this entry.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
typestringOptionalField name (the JSONB key from hris_employment_eligibility.eligibility_data, e.g. socialSecurity, idNumber, taxIdentificationNumber).
valueModelOptionalExpand Retrieve a single person — 200 response body — data additional details null item value
Raw value associated with the field. May be a string, number, boolean, or null.

Referenced models: Retrieve a single person — 200 response body — data additional details null item value

List of People — 200 response body — data item addresses null item
FieldTypePresenceDescription and constraints
$objectRoot
countryJSONOptional
country (anyOf 1)stringAlternativeCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
country (anyOf 2)nullAlternativeCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
lineTwostringOptionalSecond address line.
localitystringOptionalLocality name.
postalCodestringOptionalPostal code.
regionstringOptionalRegion code.
streetAddressstringOptionalStreet and number.
Retrieve a single person — 200 response body — data client legal entity
FieldTypePresenceDescription and constraints
$objectRootThe primary client legal entity associated with the employee.
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of this resource.
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier of this resource.
Format: uuid
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the client legal entity.
name (anyOf 2)nullAlternativeThe name of the client legal entity.
List of People — 200 response body — data item department
FieldTypePresenceDescription and constraints
$objectRootThe department of the employee.
idstringOptionalUnique identifier of this resource.
Format: uuid
namestringOptionalThe name of the department.
parentstringOptionalThe parent department name.
List of People — 200 response body — data item direct manager The direct manager of the employee
FieldTypePresenceDescription and constraints
$objectRootThe direct manager of the employee.
first_namestringOptionalThe first name of the manager.
idstringOptionalUnique identifier for the manager.
last_namestringOptionalThe last name of the manager.
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email of the manager.
work_email (anyOf 2)nullAlternativeThe work email of the manager.
worker_idJSONOptional
worker_id (anyOf 1)numberAlternativeThe worker ID of the manager.
Format: double
worker_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
List of People — 200 response body — data item direct reports The direct reports to the employee item
FieldTypePresenceDescription and constraints
$objectRoot
first_namestringOptionalThe first name of the direct report.
idstringOptionalUnique identifier for the direct report.
last_namestringOptionalThe last name of the direct report.
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email of the direct report.
work_email (anyOf 2)nullAlternativeThe work email of the direct report.
List of People — 200 response body — data item emails An array of the employee's email addresses item
FieldTypePresenceDescription and constraints
$objectRoot
typeJSONOptional
type (anyOf 1)stringAlternativeThe type of email.
type (anyOf 2)nullAlternativeThe type of email.
valueJSONOptional
value (anyOf 1)stringAlternativeThe email address.
value (anyOf 2)nullAlternativeThe email address.
Retrieve a single person — 200 response body — data additional details null item value
FieldTypePresenceDescription and constraints
$JSONRootRaw value associated with the field. May be a string, number, boolean, or null.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3)booleanAlternative
$ (anyOf 4)objectAlternativeAdditional keys: see wildcard field
$ (anyOf 4).*JSONAdditional keysAny type
Retrieve a single person — 200 response body — data employments item client legal entity id, name
FieldTypePresenceDescription and constraints
$objectRootThe client legal entity associated with this employment contract.
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of this resource.
Format: uuid
id (anyOf 2)nullAlternativeUnique identifier of this resource.
Format: uuid
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the client legal entity.
name (anyOf 2)nullAlternativeThe name of the client legal entity.

SDK function policy ID: deel.people_getpeople. Catalog operation: people_getpeople. 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.