---
title: "Get employee onboarding experience by id"
method: GET
path: "/api/v1/employees/{employeeId}/onboarding-experiences/{onboardingExperienceId}"
tags: ["Onboarding", "Public API"]
---

# Get employee onboarding experience by id

`GET /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.

OAuth Scopes: onboarding

## Path parameters

- `employeeId` integer, required
- `onboardingExperienceId` integer, required

## Response `200`

Success

- OnboardingExperiencePublicApi — Onboarding experience for public APIs; links to the new hire packet instance by id only.
  - `id` integer — Onboarding experience id (same as the new hire packet instance primary key).
  - `employeeId` integer — Employee this onboarding experience belongs to.
  - `newHirePacketId` integer — Primary key of the linked new hire packet instance (NHP row).
  - `nhpTemplateId` integer, nullable — Linked NHP template id, if any.
  - `nhpConfigurationId` integer, nullable — Linked NHP configuration id, if any.
  - `status` 'cancelled' | 'completed' | 'sent' | 'draft' — Derived lifecycle status for the linked new hire packet instance.

## Other responses

- `403` — Forbidden — missing OAuth permission, onboarding experience phase-1 / workflow framework feature not enabled for the company, or caller cannot access the employee.
- `404` — Not found — no matching running workflow, id does not match the employee’s current packet instance, or no such row.
- `500` — Internal server error

---

[API](https://skmtc.net/bamboohr/apis/bamboohr-api.md) · [All operations](https://skmtc.net/bamboohr/apis/bamboohr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bamboohr/bamboohr-api/revisions/19ebf391a399/schema)