Onboarding
Public API
Get welcome new hires widget
Changed onReturns 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
get/api/v1/onboarding/new-hire-widget
Request
- Base URLhttps://companySubDomain.bamboohr.com
- AuthOAuth 2Authorization code/authorize.phpToken URL/token.phpScopesonboarding
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
Success
Changes
- info
api operation id
044949386f2d655c6a627ef53f9434b7removed and replaced withb5c0155d30e7dc52aabacf0a2db87e48
- info