Get Onboarding Packs

The "Get Onboarding Packs" endpoint retrieves all onboarding packs configured for your company. This is useful for discovering which packs are available before assigning users to them.

Endpoint

GET https://api.connecteam.com/onboarding/v1/packs

Authentication

API Key or OAuth 2.0
OAuth Scope: onboarding.read

Response Structure

The API returns a list of all onboarding packs in your company.

Payload example:

{
  "requestId": "f7e83b20-1234-4abc-b567-aa99bb112233",
  "data": {
    "packs": [
      {
        "id": 1001,
        "name": "New Employee Onboarding",
        "description": "Standard onboarding pack for all new employees",
        "isDefault": true
      },
      {
        "id": 1002,
        "name": "Manager Onboarding",
        "description": "Onboarding pack for new managers",
        "isDefault": false
      }
    ]
  }
}

Response Fields

Field	Type	Description
`data.packs[].id`	integer	Unique identifier for the onboarding pack
`data.packs[].name`	string	The name of the onboarding pack
`data.packs[].description`	string (nullable)	Optional description of the pack
`data.packs[].isDefault`	boolean	Whether this is the default pack assigned to new users

Practical Use Cases

Use Case: Automated New Hire Assignment

When creating a new user via the Users API, you may want to automatically assign them to the correct onboarding pack:

Call GET /onboarding/v1/packs to retrieve all available packs
Identify the correct pack based on the user’s role or department
Call POST /onboarding/v1/packs/{packId}/assignments to assign the user

Get Onboarding Packs API Reference