Deel: List of People

← people operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.people_getpeople

Provider route: GET /people. Alter supplies the connection’s credentials and routing.

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"]["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()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.offset	integer	Optional	Default: 0 Maximum: 999999999 Minimum: 0
query.limit	integer	Optional	Maximum: 200 Minimum: 1
query.search	string	Optional
query.teams	array	Optional
query.teams[]	string	Each item	Format: uuid
query.fields	array	Optional
query.fields[]	Model	Each item	Expand List of People — request body — query fields item
query.sort_by	string	Optional	One 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_order	string	Optional	One of: asc, desc
query.hiring_statuses	array	Optional
query.hiring_statuses[]	string	Each item	One of: pending_invite, draft, invited, onboarding, onboarding_at_risk, onboarding_overdue, onboarded, offboarding, active, inactive, in_review, quote_requires_changes
query.band_placements	array	Optional
query.band_placements[]	string	Each item	One of: ABOVE, WITHIN, BELOW
query.comparative_ratios_from	string	Optional
query.comparative_ratios_to	string	Optional
query.hiring_types	array	Optional
query.hiring_types[]	string	Each item	One of: contractor, eor, peo, hris_direct_employee, hris_direct_contractor, direct_employee, contractor_outside_deel, person_without_contract
query.person_statuses	array	Optional
query.person_statuses[]	string	Each item	One of: ACTIVE, NOT_STARTED, INACTIVE

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

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 List of People — 200 response body

Referenced models: List of People — 200 response body

Policy, approvals and errors

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