Favicon

You are here: Home > API Reference > Workspace > Organization > List organization access control groups

List organization access control groups

Required Permission: base.organization.management.listGroups

Retrieves access control groups within organization scope enabling role-based permissions management, team segmentation, and streamlined assignment of users to applications.

GET
/v1/organizations/:organizationId/groups
Copy to clipboard

List organization access control groups

Required Permission: base.organization.management.listGroups

Retrieves access control groups within organization scope enabling role-based permissions management, team segmentation, and streamlined assignment of users to applications.

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationId string
required
Organization unique identifier or URL-friendly slug used for workspace access, API routing, and resource isolation across dashboard.
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
scope string
optional
Scope filter limited to the org value for retrieving organization-level access groups as opposed to application-specific or system-level permissions groups.
org
visibility array
optional

Responses

200 Response application/json
status boolean optional
data object optional
items array [object] optional
value string optional
Access control group identifier for organization-level permissions enabling role-based team management.
≤ 256 characters
{
    "status": true,
    "data": {
        "items": [
            {
                "value": "org.administrators"
            }
        ]
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}