List all permissions on an organization

GET

/api/v2/organizations/{organization_id}/permissions

Retrieves a list of all users who have permissions on a specific organization.
This endpoint provides a comprehensive view of organization access controls, showing which users can access the organization and their respective roles.

Path Parameters:

organization_id (int): The ID of the organization

Authorization:

Requires manage permission on the organization

Request Headers:

X-Authorization-Consistency-Token (string, optional): Authorization consistency token for read-after-write consistency. Pass the token received from a previous write operation to ensure this read reflects that write.

Returns:

A response containing lists of users with their permissions, including:

Users: user_id, first_name, last_name, email, relations (roles: admin, member, staff),
permission_sets (sets assigned directly to the user) and inherited_permission_sets
(sets the user gets from their teams). Both are empty when the permission-sets
feature is disabled.

Changelog:

2.2: Added inherited_permission_sets to each user — the permission sets inherited from their teams, kept separate from the directly assigned permission_sets.

2.1: Added permission_sets to each user.

2.0: Initial version

Current Version:

2.2.0

Request

Path Params

Header Params

Responses

🟢200

application/json

Successfully retrieved organization permissions

Bodyapplication/json

🟠400

🟠403

🟠404

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/organizations//permissions' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Direct and team-inherited permission sets

{
    "success": true,
    "message": "Organization permissions retrieved successfully",
    "data": {
        "organization_id": 1,
        "organization_name": "Example Org",
        "users": [
            {
                "user_id": "42",
                "first_name": "Jane",
                "last_name": "Doe",
                "email": "[email protected]",
                "relations": [
                    "member"
                ],
                "permission_sets": [
                    {
                        "id": "6f1c2d3e-4b5a-4c7d-8e9f-0a1b2c3d4e5f",
                        "name": "Agent Editors"
                    }
                ],
                "inherited_permission_sets": [
                    {
                        "id": "0b9e8d7c-6a5f-4e3d-2c1b-a09f8e7d6c5b",
                        "name": "Corpus Viewers"
                    }
                ]
            }
        ],
        "total_users": 1
    }
}

Organizations

Grant permission on an organization