Skip to content

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.

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 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.get_onboarding_details_by_onboarding_tracker_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.tracker_idstringRequired within parent

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get onboarding details by onboarding tracker ID — 200 response body

Referenced models: Get onboarding details by onboarding tracker ID — 200 response body

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

Get onboarding details by onboarding tracker ID — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
actionsarrayOptionalActions the caller can take on this onboarding
actions[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data actions item
app_experienceModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data app experience
The app experience of the employee
bannerJSONOptionalThe one thing worth saying about this worker, or null when there is nothing
banner (anyOf 1)ModelAlternativeExpand Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO
banner (anyOf 2)nullAlternative
bannersarrayOptionalThe banner above, then every other action that waits on the client (deposit, agreement review, H&S)
banners[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data banners item
checklistModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data checklist
List of checklist steps
contractModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data contract
Information about the contract
contractsarrayOptionalEvery contract of the worker the caller can see, the main one first
contracts[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data contracts item
hiring_typestringOptionalHiring type (e.g., contractor)
hris_profileModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data hris profile
Employee HRIS profile information
profileJSONOptionalEmployee profile information
profile (anyOf 1)ModelAlternativeExpand Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information
profile (anyOf 2)nullAlternative
progressModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data progress
Progress of the onboarding process
stepperarrayOptionalList of stepper actions taken during the onboarding process
stepper[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data stepper item
summaryarrayOptionalSummary of the onboarding process
summary[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data summary item

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
FieldTypePresenceDescription and constraints
$objectRoot
availablebooleanOptionalWhether the action can be taken now
dataobjectOptionalDetails the action needs, which vary by action
Additional keys: see wildcard field
data.*JSONAdditional keysAny type
last_execution_atJSONOptional
last_execution_at (anyOf 1)stringAlternativeWhen the action was last taken, if ever
Format: date-time
last_execution_at (anyOf 2)nullAlternativeWhen the action was last taken, if ever
Format: date-time
typestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootThe app experience of the employee
experience_typeJSONOptionalThe app experience the employee is given, when there is a specific one
experience_type (anyOf 1)stringAlternativeThe app experience the employee is given, when there is a specific one
Known values: LIGHTWEIGHT
experience_type (anyOf 2)nullAlternative
is_minimal_requirementsbooleanOptionalWhether 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
FieldTypePresenceDescription and constraints
$objectRootThe one thing worth saying about this worker, or null when there is nothing
actionJSONOptionalWhat the client can do about it, when there is something
action (anyOf 1)stringAlternativeWhat 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)nullAlternative
keyModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data banners item key
What the banner is about
severitystringOptionalHow 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
FieldTypePresenceDescription and constraints
$objectRoot
actionJSONOptionalWhat the client can do about it, when there is something
action (anyOf 1)stringAlternativeWhat 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)nullAlternative
keyModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data banners item key
What the banner is about
severitystringOptionalHow 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
FieldTypePresenceDescription and constraints
$objectRootList of checklist steps
stepsarrayOptionalList of checklist steps
steps[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data checklist steps item
summaryModelOptionalExpand 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

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"}

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.