Deel: List onboarding employees

← onboarding operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.onboarding_listonboardingemployees_v2026_01_01

Provider route: GET /onboarding/tracker. 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["onboarding"]["listOnboardingEmployees"]>[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.onboarding.listOnboardingEmployees(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.onboarding.list_onboarding_employees(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.search	string	Optional	Maximum length: 255
query.contractOid	array	Optional	Default: []
query.contractOid[]	string	Each item
query.hiringTypes	array	Optional	Default: []
query.hiringTypes[]	string	Each item	Hiring type (e.g., contractor, eor) One of: contractor, direct_employee, hris_direct_employee, hris_direct_contractor, eor, peo, person_without_contract
query.progressStatuses	array	Optional	Default: []
query.progressStatuses[]	string	Each item	Progress status of the contract One of: ONBOARDING_AT_RISK, ONBOARDING_OVERDUE, INVITED, ONBOARDING, READY_TO_START, INACTIVE, PENDING_INVITE, ACTIVE, DRAFT, OFFBOARDING, QUOTE_REQUIRES_CHANGES, IN_REVIEW, IN_OFFER_STAGE
query.countries	array	Optional	Default: []
query.countries[]	string	Each item
query.teams	array	Optional	Default: []
query.teams[]	string	Each item
query.legalEntities	array	Optional	Default: []
query.legalEntities[]	string	Each item
query.hrisDirectManagers	array	Optional	Default: []
query.hrisDirectManagers[]	string	Each item	Format: uuid
query.fromDate	string	Optional	Format: date-time
query.toDate	string	Optional	Format: date-time
query.actions	array	Optional	Default: []
query.actions[]	string	Each item	One of: CLIENT_ACTION_REQUIRED, CLIENT_ACTION_NOT_REQUIRED
query.lifecycleStatuses	array	Optional	Default: []
query.lifecycleStatuses[]	string	Each item	Lifecycle status of the onboarding One of: DRAFT, IN_REVIEW, QUOTE_REQUIRES_CHANGES, PENDING_INVITE, INVITED, ONBOARDING, ONBOARDING_AT_RISK, ONBOARDING_OVERDUE, OFFBOARDING, ONBOARDED
query.waitingOnParties	array	Optional	Default: []
query.waitingOnParties[]	string	Each item	Party the onboarding is waiting on One of: WORKER, CLIENT, DEEL
query.card	string	Optional	One of: ACTION_REQUIRED, OVERDUE, WITH_DEEL_FOR_REVIEW, READY_TO_START, STARTING_THIS_WEEK
query.weekFromDate	string	Optional	Format: date
query.weekToDate	string	Optional	Format: date
query.limit	integer	Optional	Default: 20 Maximum: 200 Minimum: 1
query.sort_by	string	Optional	Default: progressStatusWeight One of: progressStatusWeight
query.sort_order	string	Optional	Default: ASC One of: ASC, DESC
query.cursor	string	Optional
query.include_overview	boolean	Optional	Default: false

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 onboarding employees — 200 response body

Referenced models: List onboarding employees — 200 response body

Policy, approvals and errors

SDK function policy ID: deel.onboarding_listonboardingemployees_v2026_01_01. Catalog operation: onboarding_listonboardingemployees_v2026_01_01. 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: ["contracts:read", "people:read"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source