Onboarding API Released

Introducing the Onboarding API — a new set of endpoints to manage user onboarding packs and assignments programmatically as part of your HR integration flows.

New Endpoints

• GET /onboarding/v1/packs — Retrieve all onboarding packs configured for your company
• GET /onboarding/v1/packs/{packId}/assignments — Get all users assigned to a specific pack along with their onboarding status
• POST /onboarding/v1/packs/{packId}/assignments — Assign one or more users to an onboarding pack (up to 500 users per request)

Key Features

• Onboarding Status Tracking: The assignment response includes status (in_progress / completed) and isWaitingApproval to track each user's progress through the pack
• Bulk Assignment: Assign up to 500 users in a single all-or-nothing request
• HR Hub Integration: Part of the HR Hub plan capabilities

OAuth Scopes

• onboarding.read — required for GET endpoints
• onboarding.write — required for POST endpoints

For more details, see the Onboarding Guides and the API Reference.