Users and groups

The user and group APIs manage the user lifecycle and the organizational structure on Mindtickle. You can create, update, search, and deactivate users one at a time or in bulk, manage group membership, create and maintain groups, assign or remove groups from series and modules, and track the status of the asynchronous operations these endpoints start.

Key capabilities

• User management: Create, update, search, and deactivate individual or bulk users.
• Group association: Add or remove users from groups to automate hierarchy management.
• Group management: Create, update, retrieve, delete, and search for user groups.
• Bulk content assignment: Enroll or remove entire groups from series and modules.
• Process tracking: Monitor the status of asynchronous user and group operations.

Prerequisites and shared context

To work with these endpoints, you need the following platform standards:

• Authentication: How to generate and use your Bearer token.
• Base URLs: The correct regional endpoint for your account.
• Rate limits: Platform quotas and retry logic.
• Conventions: Standard JSON data formats and HTTP status codes.

For more information, see Authentication and setup.

Shared behavior across this category:

• Asynchronous user operations return a processIds array. Group invitations and removals return a singular processId. Pass the returned IDs to Check process status for user operations or Check process status for group operations. Other operations return their result directly; follow the response contract on the endpoint page.
• Updating profile fields for a deactivated learner through the user APIs reactivates the learner.
• The identifier you send for a user depends on whether UID is enabled for your Mindtickle instance: the username when UID is enabled, the email when UID is disabled.

In this category

• Users: Create, update, search, deactivate, and group users, and look up time zone values.
  • Create a user: Creates a user on the Mindtickle platform.
  • Update a user: Updates an existing user.
  • Add or update multiple users: Adds or updates multiple users in one request.
  • Search users: Searches for users in the learning site.
  • Get a user: Returns the details of a user.
  • Deactivate a user: Deactivates a user.
  • Deactivate multiple users: Deactivates one or more users in one request.
  • Add a user to groups: Adds a user to one or more groups.
  • Add multiple users to groups: Adds multiple users to one or more groups.
  • Remove users from a group: Removes one or more users from a group.
  • Check process status: Returns the status of the processes started by the user APIs.
  • Time zone values: The supported time zones and their ID values.
• Groups: Create, update, search, and delete groups, and invite groups to series and modules.
  • Create a group: Creates a group on the Mindtickle platform.
  • Update a group: Updates an existing group.
  • Search groups: Searches for groups by name or ID.
  • Get a group: Returns the details of a group.
  • Delete a group: Deletes a group.
  • Invite groups to a series: Invites one or more groups to a series.
  • Invite groups to a module: Invites one or more groups to a module of a series.
  • Remove groups from a series: Removes one or more groups from a series.
  • Remove groups from a module: Removes one or more groups from a module of a series.
  • Check process status: Returns the status of the processes started by the group APIs.

Related

• Getting started: Base URLs, authentication, rate limits, and status codes.
• Authentication and setup: Generate the access token these endpoints need.
• Training: The series and modules you invite users and groups to.