Get employee onboarding experience by id

get

https://{companyDomain}.bamboohr.com/api/v1/employees/{employeeId}/onboarding-experiences/{onboardingExperienceId}

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

403Forbidden — missing OAuth permission, onboarding experience phase-1 / workflow framework feature not enabled for the company, or caller cannot access the employee.

404Not found — no matching running workflow, id does not match the employee’s current packet instance, or no such row.

500Internal server error