For Developers

Team Roles Overview

A Team Role defines a set of system permissions granted to members of a team. Teams can utilize built-in managed roles or create custom roles with tailored permission subsets.

Retrieve valid permission slugs from List Team Role Permissions. To grant a role to a member, use the role assignment endpoints.

Properties

PropertyTypeDescription
idUUIDUnique identifier for the team role.
created_dateDateDate when the role was created.
updated_dateDateLast modification timestamp.
nameStringName of the role (e.g. "Integration Manager").
descriptionStringOptional description of the role responsibilities.
permissionsArrayPermission rows. Each row has permission (a system permission slug), mode, and target_ids. Create and update accept permission slugs as a string array. Updating permissions replaces the role’s permission set.

JSON Example

{
    "id": "3b7d4bad-9bdd-2b0d-7b3d-cb6d9b1deb4d",
    "name": "Integration Manager",
    "description": "Full access to configure and monitor school integrations",
    "permissions": [
        {
            "permission": "integrations.read",
            "mode": "all",
            "target_ids": []
        }
    ]
}