> ## Documentation Index
> Fetch the complete documentation index at: https://www.edenai.co/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List roles

> Lists the roles members can be given, ordered by name: the system roles and the organization's custom roles. Requires the `manage:read` scope.



## OpenAPI

````yaml https://api.edenai.run/v2/info/splitted-schema/management_api/openapi.json get /v3/manage/roles/
openapi: 3.0.3
info:
  title: Organization Management
  version: '2.0'
  description: Your project description
servers:
  - url: https://api.edenai.run
security: []
paths:
  /v3/manage/roles/:
    get:
      tags:
        - Roles
      summary: List roles
      description: >-
        Lists the roles members can be given, ordered by name: the system roles
        and the organization's custom roles. Requires the `manage:read` scope.
      operationId: manage_roles_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - name: offset
          required: false
          in: query
          description: The initial index from which to return the results.
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedManageRoleList'
          description: ''
      security:
        - ManagementKeyAuth: []
components:
  schemas:
    PaginatedManageRoleList:
      type: object
      required:
        - results
        - limit
        - offset
        - total_count
        - next
        - previous
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/ManageRole'
        limit:
          type: integer
          example: 25
          description: Page size applied to this response (max 100).
        offset:
          type: integer
          example: 0
          description: Index of the first item in this page.
        total_count:
          type: integer
          example: 123
          description: Total number of items across all pages.
        next:
          type: string
          nullable: true
          format: uri
          example: https://api.edenai.run/v3/manage/members/?limit=25&offset=25
          description: Absolute URL of the next page, or null on the last page.
        previous:
          type: string
          nullable: true
          format: uri
          description: Absolute URL of the previous page, or null on the first page.
    ManageRole:
      type: object
      description: >-
        A role. System roles (`is_system: true`) are shared by every
        organization and cannot be

        changed; the others are the organization's own. `guardrail_id` is the
        guardrail that applies

        to the role's members, or null.
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 100
        description:
          type: string
        is_system:
          type: boolean
        permissions:
          type: array
          items:
            type: string
            maxLength: 100
        guardrail_id:
          type: integer
          readOnly: true
      required:
        - guardrail_id
        - id
        - name
  securitySchemes:
    ManagementKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: >-
        A management key (created from the organization dashboard or with `POST
        /v3/manage/auth-keys`), sent as `Authorization: Bearer
        <management_key>`. Inference API keys (`sk-eden...`) are not accepted on
        these endpoints.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.