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.
The identity and technical contract details declared by the specification.
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Deel publishes across the network.