Overview

The following step-by-step guide will walk you through managing user onboarding in Connecteam via our REST API.

Upon completion of this guide, you will be able to interact with the Connecteam platform as follows:

• Get onboarding packs — retrieve all packs configured in your company
• Get pack assignments — retrieve all users assigned to a pack along with their onboarding progress
• Assign users to a pack — assign one or more users to an onboarding pack in a single request

🚧

Plan Requirement

The Onboarding API is available on the HR Hub plan. Make sure your account has the HR Hub feature enabled.

What are Onboarding Packs?

Onboarding packs in Connecteam are structured onboarding programs made up of steps that new employees must complete. Each pack can contain a mix of required and optional steps such as forms, courses, tasks, and documents.

Packs can be configured in the Connecteam dashboard and then managed programmatically via the API.

What can you achieve with the Onboarding API

By integrating with the Onboarding API, you can automate the assignment of onboarding packs as part of your new hire workflows.

Common use cases:

• Automatically assigning a new hire to the correct onboarding pack when they are created via the Users API
• Monitoring onboarding progress and triggering follow-up actions when employees complete their packs
• Building HR dashboards that display real-time onboarding status across all active employees

Important Considerations

All-or-Nothing Assignment: When assigning multiple users to a pack, the request is atomic — if any user ID in the list is invalid, no assignments are created.

Batch Limit: You can assign up to 500 users per request.

Approval Flow: Some packs require admin approval after a user completes all required steps. The isWaitingApproval field in the assignment response indicates whether a user is pending approval.

Status Values: The status field on each assignment uses the following values:

• in_progress — the user is working through the pack
• completed — the user has finished all required steps and the assignment has been approved

For detailed information and examples, please refer to the following pages.