Manage Pack Assignments

The Assignments endpoints allow you to retrieve the status of users within a specific onboarding pack and to assign new users to a pack.

🚧
Important Note
Assigning users to a pack is an all-or-nothing operation. If any user ID in the request is invalid or does not exist, no assignments are created.

Get Pack Assignments

Retrieve all users assigned to a specific onboarding pack along with their current onboarding status and approval state.

Endpoint

GET https://api.connecteam.com/onboarding/v1/packs/{packId}/assignments

Authentication

API Key or OAuth 2.0
OAuth Scope: onboarding.read

Path Parameters

Parameter	Type	Required	Description
`packId`	integer	required	The ID of the onboarding pack

Response Example

{
  "requestId": "a1b2c3d4-5678-90ab-cdef-111213141516",
  "data": {
    "assignments": [
      {
        "id": 501,
        "userId": 7031021,
        "status": "in_progress",
        "isWaitingApproval": false
      },
      {
        "id": 502,
        "userId": 7031022,
        "status": "completed",
        "isWaitingApproval": false
      },
      {
        "id": 503,
        "userId": 7031023,
        "status": "in_progress",
        "isWaitingApproval": true
      }
    ]
  }
}

Response Fields

Field	Type	Description
`data.assignments[].id`	integer	Unique assignment ID
`data.assignments[].userId`	integer	The Connecteam user ID
`data.assignments[].status`	string	Onboarding status: `in_progress` or `completed`
`data.assignments[].isWaitingApproval`	boolean	`true` when the user completed all required steps and is pending admin approval

Assign Users to a Pack

Assign one or more users to a specific onboarding pack in a single request.

Endpoint

POST https://api.connecteam.com/onboarding/v1/packs/{packId}/assignments

Authentication

API Key or OAuth 2.0
OAuth Scope: onboarding.write

Path Parameters

Parameter	Type	Required	Description
`packId`	integer	required	The ID of the onboarding pack

Request Body

{
  "userIds": [7031021, 7031022, 7031023]
}

Request Body Fields

Field	Type	Required	Description
`userIds`	array of integers	required	List of user IDs to assign. Max 500 per request, no duplicates allowed.

Response

A successful response returns HTTP 200 with an empty data object.

{
  "requestId": "d4e5f6a7-8901-23bc-def4-567890abcdef",
  "data": {}
}

Error Codes

HTTP Status	Description
`404`	Onboarding pack not found for the given `packId`
`422`	Validation error — `userIds` is empty, contains duplicates, or contains a user ID that does not exist

Get Pack Assignments API Reference
Assign Users to Pack API Reference