v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Onboarding

Public API

Get employee onboarding experience by id

Returns a single onboarding experience when the onboarding experience phase-1 and workflow framework company toggles are enabled, the employee has at least one running OnboardingExperienceWorkflow (execution status RUNNING), the path id matches their current new hire packet instance id, and the row belongs to the employee. NHP fields are referenced by id only.

OAuth Scopes: onboarding

get/api/v1/employees/{employeeId}/onboarding-experiences/{onboardingExperienceId}

Path parameters

employeeIdinteger required

onboardingExperienceIdinteger required

Response

Success

idinteger

Onboarding experience id (same as the new hire packet instance primary key).

employeeIdinteger

Employee this onboarding experience belongs to.

newHirePacketIdinteger

Primary key of the linked new hire packet instance (NHP row).

nhpTemplateIdinteger nullable

Linked NHP template id, if any.

nhpConfigurationIdinteger nullable

Linked NHP configuration id, if any.

status'cancelled' | 'completed' | 'sent' | 'draft'

Derived lifecycle status for the linked new hire packet instance.