Account Information13

Alerts5

Applicant Tracking10

Benefits10

Calendar Events1

Change Tracking2

Company Files6

Company Profile3

Compensation3

Compensation Benchmarking11

Compensation Planning28

Custom Fields12

Custom Reports4

Custom Tables7

Datasets8

Employee Files6

Employee Tables6

Employee Verification5

Employees8

Field Metadata4

Goals24

Holidays8

Hours1

Locations5

Login1

Meal & Rest Breaks20

Onboarding12

Pay Grades & Bands14

Photos2

Public API5

Recognition Settings1

Reports2

Scheduling21

Time Off37

Time Tracking63

Total Rewards8

Training12

Webhooks8

Webhooks

Webhook Events6

Onboarding

Public API

List new hire packets

Changed on Nov 3, 2026

Returns a paginated list of new hire packet instances for the company. Each item is a flat summary (no sections, tasks, questions, or GTKY recipients).

OAuth Scopes: onboarding

get/api/v1/new-hire-packets

Request

Base URL
https://companySubDomain.bamboohr.com
Auth
OAuth 2
Authorization code/authorize.php
Token URL/token.php
Scopesonboarding
TypeScript
https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/new-hire-packets/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageinteger

pageSizeinteger

Response

Success

pageinteger

Current page number (1-based).

pageSizeinteger

Page size used for this response.

totalCountinteger

Total packet rows matching visibility (across all pages).

Changes

Nov 3, 2026922fc15f43a7 Revision changes
- info
  api operation id f44b802c30cdea2b9076b3f82f99c74d removed and replaced with 6d181e2defa79e054c4415c11dc42dab

Operation history

List new hire packets

Request

Query parameters

Response 200OK

Changes

Response