---
updatedAt: 2026-06-12T14:47:10.000Z
agentTools:
  projectIndex: https://docs.formant.io/llms.txt
---

# List

List all roles in your organization.
Resource: roles
Authorized roles: viewer

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "Role": {
        "properties": {
          "organizationId": {
            "format": "uuid",
            "type": "string",
            "description": "ID of the organization to which this user belongs."
          },
          "name": {
            "type": "string",
            "description": "Name of this role."
          },
          "policies": {
            "description": "Access policies of this role in JSON format."
          },
          "isImmutable": {
            "type": "boolean",
            "description": "Can this role be changed after creation?"
          },
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "tags": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "type": "object",
        "required": [
          "name",
          "policies"
        ]
      },
      "RoleListResponse": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Role"
            },
            "type": "array"
          }
        },
        "type": "object",
        "required": [
          "items"
        ]
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "info": {
    "title": "Formant admin-api",
    "version": "1.357.8"
  },
  "openapi": "3.0.0",
  "paths": {
    "/roles/": {
      "get": {
        "operationId": "RoleController.list",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RoleListResponse"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "List",
        "tags": [
          "Role"
        ],
        "description": "List all roles in your organization.\nResource: roles\nAuthorized roles: viewer",
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.formant.io/v1/admin"
    }
  ]
}
```