BAbamboohr
Onboarding
Public API

Get new hire packet by id

Changed on

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

OAuth Scopes: onboarding

get/api/v1/new-hire-packets/{id}

Request

Path parameters

idinteger required

Response

Success

idinteger nullable

Primary key of the new hire packet instance.

employeeIdinteger

Employee this packet belongs to.

contactEmployeeIdinteger nullable

Contact employee for the packet, if any.

requiresPersonalInformationboolean
requiresPhotoboolean
requiresPersonalQuestionsboolean
arriveByTimestring nullable

Expected arrival time (time portion).

locationstring nullable

Work location label for the new hire.

sentDatetimestring nullable

When the packet was sent (datetime string).

viewedDatetimestring nullable

When the packet was first viewed (datetime string).

completedDatetimestring nullable

When the packet was completed (datetime string).

createdByUserIdinteger nullable
createdDatetimestring nullable

When the packet row was created (datetime string).

sendGetToKnowYouEmailboolean
getToKnowYouEmailSentboolean nullable
showPayrollStateboolean nullable
showPayrollFederalboolean nullable
showPayrollDirectDepositboolean nullable
nhpConfigurationIdinteger nullable

Linked new hire packet configuration id, if any.

nhpTemplateIdinteger nullable
countNhpGtkySentinteger nullable
cancelledboolean
includePhotoOptionboolean

Whether photo collection is offered based on configuration.

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

Derived lifecycle status for the instance.

Changes

  • 922fc15f43a7Revision changes
    • info

      api operation id 696f0a229cdde60b733568e3c4d043d9 removed and replaced with 9e50205e7d1577fae12f069776d705f7