List all Permissions on a Team

GET

/api/v2/teams/{team_id}/permissions

Lists the users who belong to a team and the role each one holds. Use it to show a team's
members and admins, or to see who keeps access before you remove someone.

Only roles given on the team itself are listed, so indirect_permissions is always empty;
organization admins can manage every team but aren't listed. The list isn't paged.

Requires view on the team: being one of its members or admins, or an organization admin.

Request

Path Params

Header Params

Responses

🟢200

application/json

The team's members and admins.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/teams//permissions' \
--header 'X-Authorization-Consistency-Token;' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Team members

{
    "success": true,
    "message": "Team permissions retrieved successfully",
    "data": {
        "team_id": 9,
        "team_name": "Support Leads",
        "organization_id": 3,
        "direct_permissions": {
            "users": [
                {
                    "user_id": "15",
                    "user_name": "Dana Lee",
                    "email": "[email protected]",
                    "relations": [
                        "admin"
                    ]
                },
                {
                    "user_id": "21",
                    "user_name": "Sam Ortiz",
                    "email": "[email protected]",
                    "relations": [
                        "member"
                    ]
                }
            ],
            "teams": []
        },
        "indirect_permissions": {
            "users": [],
            "teams": []
        }
    }
}

Teams

Grant Permission on a Team