How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Deel subpackage_onboarding API

The subpackage_onboarding API from Deel — 3 operation(s) for subpackage_onboarding.

Deel subpackage_onboarding API is one of 91 APIs that Deel publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 3 operations across 3 paths, and defines 55 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.letsdeel.com/rest/v2, https://api-staging.letsdeel.com/rest/v2.

3 operations 3 paths 55 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
https://api.letsdeel.com/rest/v2
https://api-staging.letsdeel.com/rest/v2
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Deel subpackage_onboarding API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (deelToken). It accepts HTTP bearer tokens (oauth2).

  • deelToken — Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authenticatio…
  • oauth2 — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

subpackage_onboarding 3
GET
/onboarding/tracker/hris_profile/{hris_profile_id}
Get onboarding details by employee HRIS profile ID
get-onboarding-details-by-employee-hris-profile-id-v-2026-01-01 2 params → 200400401403404500
GET
/onboarding/tracker/{tracker_id}
Get onboarding details by onboarding tracker ID
get-onboarding-details-by-onboarding-tracker-id-v-2026-01-01 2 params → 200400401403404500
GET
/onboarding/tracker
List onboarding employees
list-onboarding-employees-v-2026-01-01 17 params → 200400401403404500

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContract (12 properties), OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContract (12 properties), OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress (8 properties), OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaData (8 properties). Each schema is shown below with its type and property counts.

Onboarding_getOnboardingDetailsByOnboardingTrackerId-v2026-01-01_Response_200
object
1 property
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData
object
2 properties
OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress
object
The progress state of the onboarding
8 properties
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContract
object
Information about the contract
12 properties
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData
object
2 properties
OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract
object
The contract associated with the onboarding
2 properties
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems
object
Checklist step information
5 properties
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems
object
1 property
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContract
object
Information about the contract
12 properties
OnboardingTrackerGetResponsesContentApplicationJsonSchemaPage
object
2 properties
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfile
object
Employee profile information
5 properties
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement
object
Information about the Employment Agreement
2 properties
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus
string
Status of the invoice
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProfile
object
Employee profile information
5 properties
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems
object
Checklist step information
5 properties
OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsItems
object
1 property 1 required
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProgress
object
Progress of the onboarding process
5 properties
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice
object
Applicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any
7 properties
OnboardingTrackerGetParametersActionsSchemaItems
string
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItems
object
Summary item information
4 properties
OnboardingTrackerGetParametersSortOrder
string
OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressReferenceDate
The reference date determining the onboarding status
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement
object
Information about the Employment Agreement
2 properties
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData
object
Additional data about the summary item
3 properties
OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience
object
The app experience of the employee
1 property
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProgress
object
Progress of the onboarding process
5 properties
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData
object
Additional data about the summary item
3 properties
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice
object
Only applicable for EOR contracts. First early invoice (EOR funding statement) for the contract, if any
7 properties
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaData
object
8 properties
ApiError
object
2 properties
OnboardingTrackerGetParametersSortBy
string
OnboardingTrackerGetParametersHiringTypesSchemaItems
string
Hiring type (e.g., contractor, employee)
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfile
object
Employeee HRIS profile information
4 properties
OnboardingTrackerGetParametersProgressStatusesSchemaItems
string
Progress status of the contract
OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile
object
The profile associated with the onboarding
2 properties
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfile
object
Employeee HRIS profile information
4 properties
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklist
object
List of checklist steps
1 property
ApiErrorContainer
object
2 properties
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue
Value of the summary item
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklist
object
List of checklist steps
1 property
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus
string
Status of the invoice
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems
object
1 property
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta
object
Email metadata
3 properties
Onboarding_listOnboardingEmployees-v2026-01-01_Response_200
object
2 properties
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta
object
Email metadata
3 properties
OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItems
object
Stepper action information
3 properties
OnboardingTrackerGetResponsesContentApplicationJsonSchemaRequest
object
Error request details
2 properties
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItems
object
Stepper action information
3 properties
OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems
object
7 properties
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue
Value of the summary item
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaData
object
8 properties
Onboarding_getOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01_Response_200
object
1 property
ApiErrorRequest
object
7 properties
ListOnboardingEmployees-v2026-01-01RequestBadRequestError
object
2 properties 1 required
OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItems
object
Summary item information
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deel-subpackage-onboarding-api-openapi.yml Raw ↑

Other APIs Deel publishes across the network.

Deel Default API
Deel subpackage_accounting API
Deel subpackage_adjustments API
Deel subpackage_assets API
Deel subpackage_ats API
Deel subpackage_candidates API
Deel subpackage_consent API
Deel subpackage_contractorAmendments API
Deel subpackage_contractorHiring API
Deel subpackage_contracts API
Deel subpackage_costCalculator API
Deel subpackage_costCenters API
Where this information came from

This is an independent, third-party profile of Deel subpackage_onboarding API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.