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

# List user groups

> This endpoint allows users to list groups based on their permissions.

Access levels:
- Admin/Sys Admin/Account Manager: Can view all groups across companies
- Admin DPO: Read-only access to all groups across companies
- Company Admin: Can view all groups in their company
- Company DPO: Read-only access to groups in their company
- Group members: Read-only access to groups they are members of in their company

The `has_role` filter can be combined with `user_id` to return only groups where the specified user has a particular role (e.g. `owner`). It has no effect without `user_id`.

Supports pagination and search functionality.



## OpenAPI

````yaml /api-reference/openapi-v3.yaml get /api/v3/groups
openapi: 3.0.3
info:
  title: Paradigm API
  version: xenial-xerus (v3)
  description: >-
    A versatile and adaptable tool designed to integrate Generative AI into your
    applications
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Agents
    description: Operations about agents
  - name: Threads
    description: Operations about agents conversation threads
  - name: Tools
    description: Operations about native tools
  - name: Models
    description: Operations about AI models
  - name: MCP
    description: Operations about MCP servers
  - name: Sources
    description: Operations about sources used by agents conversation threads
  - name: Artifacts
    description: Operations about artifacts generated by agents conversation threads
  - name: Agent
    description: >-
      Operations about agents (deprecated). Please use the 'Agents' API
      component instead.
  - name: Files
    description: Operations about files
  - name: Files Processing
    description: Operations about files processing
  - name: Tags
    description: Operations about tags
  - name: Workspaces
    description: Operations about workspaces
  - name: Users
    description: Operations about users
  - name: User Groups
    description: Operations about user groups
  - name: Companies
    description: Operations about companies
  - name: SCIM
    description: Operations about SCIM
paths:
  /api/v3/groups:
    get:
      tags:
        - User Groups
      summary: List user groups
      description: >-
        This endpoint allows users to list groups based on their permissions.


        Access levels:

        - Admin/Sys Admin/Account Manager: Can view all groups across companies

        - Admin DPO: Read-only access to all groups across companies

        - Company Admin: Can view all groups in their company

        - Company DPO: Read-only access to groups in their company

        - Group members: Read-only access to groups they are members of in their
        company


        The `has_role` filter can be combined with `user_id` to return only
        groups where the specified user has a particular role (e.g. `owner`). It
        has no effect without `user_id`.


        Supports pagination and search functionality.
      operationId: api_v3_groups_retrieve
      parameters:
        - in: query
          name: category
          schema:
            type: string
            enum:
              - company
              - custom
              - private
          description: 'Filter by group category: ''company'', ''private'', or ''custom'' (team).'
        - in: query
          name: company_id
          schema:
            type: integer
          description: >-
            Company ID to filter groups (only for Admin/Sys Admin/Account
            Manager)
        - in: query
          name: has_role
          schema:
            type: string
            enum:
              - member
              - owner
          description: >-
            Filter groups by the role the user (specified via user_id) has in
            them. Has no effect without user_id.
        - in: query
          name: page
          schema:
            type: integer
          description: 'Page number (default: 1)'
        - in: query
          name: per_page
          schema:
            type: integer
          description: 'Items per page (default: 20, max: 100)'
        - in: query
          name: search
          schema:
            type: string
          description: Filter by group name (case-insensitive)
        - in: query
          name: user_id
          schema:
            type: integer
          description: User ID to filter groups
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGroupListResponseList'
          description: >-
            List of groups with pagination (wrapped in 'data' field with
            'pagination' metadata)
        '403':
          description: Insufficient permissions or unauthorized company_id access
        '404':
          description: Company not found
      security:
        - bearerAuth: []
components:
  schemas:
    PaginatedGroupListResponseList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/GroupListResponse'
    GroupListResponse:
      type: object
      description: >-
        V3 Response serializer for listing user groups.

        Returns basic group information with user IDs (same format as create
        response).
      properties:
        id:
          type: integer
        company_id:
          type: integer
        category:
          type: string
        name:
          type: string
        description:
          type: string
        user_ids:
          type: string
          readOnly: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - category
        - company_id
        - created_at
        - description
        - id
        - name
        - updated_at
        - user_ids
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````