Deel: Get onboarding details by onboarding tracker ID
Deel onboarding.getOnboardingDetailsByOnboardingTrackerId: arguments, response, policy and SDK examples.
← Onboarding operations · Get started
Operation deel.onboarding_getonboardingdetailsbyonboardingtrackerid_v2026_01_01
Provider route: GET /onboarding/tracker/{tracker_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["onboarding"]["getOnboardingDetailsByOnboardingTrackerId"]>[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.getOnboardingDetailsByOnboardingTrackerId(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.onboarding.get_onboarding_details_by_onboarding_tracker_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.tracker_id | string | Required within parent |
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 Get onboarding details by onboarding tracker ID — 200 response body |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body
Schemas
Section titled “Schemas”21 more schemas are linked from the tables above, on the schema pages.
Get onboarding details by onboarding tracker ID — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data
Get onboarding details by onboarding tracker ID — 200 response body — data
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data actions item, Get onboarding details by onboarding tracker ID — 200 response body — data app experience, Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO, Get onboarding details by onboarding tracker ID — 200 response body — data banners item, Get onboarding details by onboarding tracker ID — 200 response body — data checklist, Get onboarding details by onboarding tracker ID — 200 response body — data contracts item, Get onboarding details by onboarding tracker ID — 200 response body — data summary item, Get onboarding details by onboarding tracker ID — 200 response body — data hris profile, Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information, Get onboarding details by onboarding tracker ID — 200 response body — data progress, Get onboarding details by onboarding tracker ID — 200 response body — data stepper item, Get onboarding details by onboarding tracker ID — 200 response body — data contract
Get onboarding details by onboarding tracker ID — 200 response body — data actions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
available | boolean | Optional | Whether the action can be taken now |
data | object | Optional | Details the action needs, which vary by action Additional keys: see wildcard field |
data.* | JSON | Additional keys | Any type |
last_execution_at | JSON | Optional | |
last_execution_at (anyOf 1) | string | Alternative | When the action was last taken, if ever Format: date-time |
last_execution_at (anyOf 2) | null | Alternative | When the action was last taken, if ever Format: date-time |
type | string | Optional | The action Known values: MANAGE_INVITE, RESEND_INVITE, SEND_REMINDER, CANCEL_CONTRACT, END_CONTRACT, GET_HELP |
Get onboarding details by onboarding tracker ID — 200 response body — data app experience
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The app experience of the employee |
experience_type | JSON | Optional | The app experience the employee is given, when there is a specific one |
experience_type (anyOf 1) | string | Alternative | The app experience the employee is given, when there is a specific one Known values: LIGHTWEIGHT |
experience_type (anyOf 2) | null | Alternative | |
is_minimal_requirements | boolean | Optional | Whether the worker gets the minimal app experience, as a person without a contract does |
Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The one thing worth saying about this worker, or null when there is nothing |
action | JSON | Optional | What the client can do about it, when there is something |
action (anyOf 1) | string | Alternative | What the client can do about it, when there is something Known values: CANCEL_CONTRACT, REVIEW_EMPLOYEE_AGREEMENT, PAY_DEPOSIT, VIEW_CONTRACT, SET_UP_HEALTH_SAFETY |
action (anyOf 2) | null | Alternative | |
key | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data banners item key What the banner is about |
severity | string | Optional | How serious it is Known values: ERROR, WARNING, INFO |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data banners item key
Get onboarding details by onboarding tracker ID — 200 response body — data banners item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | JSON | Optional | What the client can do about it, when there is something |
action (anyOf 1) | string | Alternative | What the client can do about it, when there is something Known values: CANCEL_CONTRACT, REVIEW_EMPLOYEE_AGREEMENT, PAY_DEPOSIT, VIEW_CONTRACT, SET_UP_HEALTH_SAFETY |
action (anyOf 2) | null | Alternative | |
key | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data banners item key What the banner is about |
severity | string | Optional | How serious it is Known values: ERROR, WARNING, INFO |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data banners item key
Get onboarding details by onboarding tracker ID — 200 response body — data checklist
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List of checklist steps |
steps | array | Optional | List of checklist steps |
steps[] | Model | Each item | Expand Get onboarding details by onboarding tracker ID — 200 response body — data checklist steps item |
summary | Model | Optional | Expand Get onboarding details by onboarding tracker ID — 200 response body — data checklist summary How far along the checklist is |
Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data checklist steps item, Get onboarding details by onboarding tracker ID — 200 response body — data checklist summary
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.onboarding_getonboardingdetailsbyonboardingtrackerid_v2026_01_01. Catalog operation: onboarding_getonboardingdetailsbyonboardingtrackerid_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"}