---
title: "Get welcome new hires widget"
method: GET
path: "/api/v1/onboarding/new-hire-widget"
tags: ["Onboarding", "Public API"]
---

# Get welcome new hires widget

`GET /api/v1/onboarding/new-hire-widget`

Returns the upcoming-new-hires data that powers the BambooHR home "Welcome New Hires" widget. Items are ordered by most recent hire date first. The list reflects the authenticated user's new-hire-packet and company-directory access — when either is missing the response is an empty list (not 403). Sensitive contact fields (work email, home email) are never returned.

OAuth Scopes: onboarding

## Response `200`

Success

- object
  - `newHires` NewHireWidgetItem[], required — Upcoming new hires visible to the authenticated user, sorted by hire date descending. Empty when the user lacks new-hire-packet or company-directory access.
    - `id` integer, required — Employee id.
    - `preferredFirstName` string, required — Nickname when set, otherwise first name.
    - `lastName` string, required
    - `hireDate` string, date, nullable, required — ISO 8601 date (YYYY-MM-DD).
    - `profilePictureUrl` string, nullable — Medium-size profile photo URL, or default silhouette URL.
    - `department` string, nullable — Department display name. Null when the authenticated user cannot view the department field.
    - `location` string, nullable — Location display name. Null when the authenticated user cannot view the location field.
    - `canSeeEmployee` boolean, required — Whether the authenticated user can navigate to the employee's profile.
    - `getToKnowYou` CompletedQuestionsAndResponseDataObject[], nullable — Completed Get-To-Know-You questions and responses for the new hire. Null when the new hire has not completed any questions or any answer is hidden.
      - `question` string — The question that was completed
      - `isRequired` boolean — Indicates if the question is required
      - `archived` boolean — Indicates if the question is archived
      - `sortOrder` integer — The sort order of the question
      - `employeeId` integer — The employee ID associated with the question
      - `employeePersonalQuestionId` integer — The employee personal question ID associated with the question
      - `employeeResponse` string — The response to the question
      - `hidden` boolean — Indicates if the question is hidden

## Other responses

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