User Group API Keys

Each user group has its own API key, scoped to the group, so integrations and AI agents can use the InSkill public API at the group level as well as at the account level. This page covers what a group's key does when you create records with it and which activity it returns.

📘
For administrators and developers only
Field-level detail for each endpoint is in the API reference, for example Create a group and Update a group.

Group and Account Keys

An account has an API key, and each user group also has one with a limited scope, so APIs can be used consistently at either level. A group's key can be rotated — replaced with a new key — when needed. To show, copy, or rotate it, open the group's Information tab — see Group Settings.

Creating Records with a Group Key

A group's API key acts for the group. When you create a record with it:

Record	What happens
User	The user is created and added to the group automatically. The user is also available to be assigned to any other user group, and is accessible at the main group.
Copilot	The copilot is created and added to the group automatically. The copilot is also available to be assigned to any other user group, and is accessible at the main group.
Asset	The asset is created. It is accessible at the group level only if it is a member of an asset group associated with the group.
User group	Creating a user group fails. InSkill doesn't allow one top-level group to be added to another; that is the purpose of a subgroup.
Subgroup	The subgroup is created and added automatically under the group the API key belongs to.

Reading Activity with a Group Key

When using a group API key to query users, diagnostic sessions, or GPT, only actions related to that group are returned. An action is related to a group based on the user's membership at the time of the action — see Groups in Intelligence and the User Log.