> ## Documentation Index
> Fetch the complete documentation index at: https://developers.qomon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve role collection

> Retrieve all roles available in the sender-selected space.



## OpenAPI

````yaml /src/autogen/users-openapi3.0.yaml get /roles
openapi: 3.1.0
info:
  description: >-
    This OpenAPI 3.1 specification describes the public API of the Qomon
    platform. It is generated from the code and serves both as documentation for
    API consumers and as a contract for future development.
  title: Qomon API Reference
  version: 0.0.1
servers:
  - description: Production
    url: https://incoming.qomon.app
security:
  - bearerAuth: []
tags:
  - description: List and manage users in the current space.
    name: Users
  - description: Create, read, update and delete teams.
    name: Teams
  - description: List roles available in the current space.
    name: Roles
  - description: Invite users by email and manage their invitations.
    name: Invitations
  - description: Send global messages to teams.
    name: Notifications
paths:
  /roles:
    get:
      tags:
        - Roles
      summary: Retrieve role collection
      description: Retrieve all roles available in the sender-selected space.
      operationId: list-roles
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusEnvelopeListRolesData'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
components:
  schemas:
    StatusEnvelopeListRolesData:
      additionalProperties: true
      properties:
        data:
          $ref: '#/components/schemas/ListRolesData'
        status:
          description: Operation result.
          examples:
            - success
          type: string
      required:
        - status
        - data
      type: object
    ErrorModel:
      additionalProperties: true
      properties:
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ListRolesData:
      additionalProperties: true
      properties:
        count:
          examples:
            - 1
          format: int64
          type: integer
        roles:
          items:
            $ref: '#/components/schemas/Role'
          type:
            - array
            - 'null'
      required:
        - count
        - roles
      type: object
    ErrorDetail:
      additionalProperties: true
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Role:
      additionalProperties: true
      properties:
        color:
          description: Role colour as a hex string.
          examples:
            - '#DF0D73'
          type: string
        id:
          description: Role ID.
          format: int64
          minimum: 0
          type: integer
        mobile:
          description: Whether the role has mobile access.
          type: boolean
        name:
          description: Role name.
          type: string
        order:
          description: Display order for roles in role management view.
          format: int64
          minimum: 0
          type: integer
        type:
          description: Role type.
          enum:
            - superadmin
            - admin
            - manager
            - user
            - custom
          type: string
        web:
          description: Whether the role has web access.
          type: boolean
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: opaque
      description: >-
        OAuth2 access token. Pass the token in the Authorization header as
        `Bearer <token>`. The token is looked up in Redis to resolve the caller
        identity.
      scheme: bearer
      type: http

````