---
title: "Get new hire packet by id"
method: GET
path: "/api/v1/new-hire-packets/{id}"
tags: ["Onboarding", "Public API"]
---

# Get new hire packet by id

`GET /api/v1/new-hire-packets/{id}`

Returns a single new hire packet instance with a derived status. Sub-resources (sections, tasks, questions, GTKY) are not included.

OAuth Scopes: onboarding

## Path parameters

- `id` integer, required

## Response `200`

Success

- NewHirePacketPublicApi — Flat new hire packet instance for public read APIs (list and detail).
  - `id` integer, nullable — Primary key of the new hire packet instance.
  - `employeeId` integer — Employee this packet belongs to.
  - `contactEmployeeId` integer, nullable — Contact employee for the packet, if any.
  - `requiresPersonalInformation` boolean
  - `requiresPhoto` boolean
  - `requiresPersonalQuestions` boolean
  - `arriveByTime` string, nullable — Expected arrival time (time portion).
  - `location` string, nullable — Work location label for the new hire.
  - `sentDatetime` string, nullable — When the packet was sent (datetime string).
  - `viewedDatetime` string, nullable — When the packet was first viewed (datetime string).
  - `completedDatetime` string, nullable — When the packet was completed (datetime string).
  - `createdByUserId` integer, nullable
  - `createdDatetime` string, nullable — When the packet row was created (datetime string).
  - `sendGetToKnowYouEmail` boolean
  - `getToKnowYouEmailSent` boolean, nullable
  - `showPayrollState` boolean, nullable
  - `showPayrollFederal` boolean, nullable
  - `showPayrollDirectDeposit` boolean, nullable
  - `nhpConfigurationId` integer, nullable — Linked new hire packet configuration id, if any.
  - `nhpTemplateId` integer, nullable
  - `countNhpGtkySent` integer, nullable
  - `cancelled` boolean
  - `includePhotoOption` boolean — Whether photo collection is offered based on configuration.
  - `status` 'cancelled' | 'completed' | 'sent' | 'draft' — Derived lifecycle status for the instance.

## Other responses

- `403` — Forbidden
- `404` — Not found
- `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)