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

# List Groups

> Use this endpoint to list all predefined groups available in the system.



## OpenAPI

````yaml en/openapi/v3-current/AM-identity.yaml get /v1/groups
openapi: 3.1.0
info:
  title: Identity Plugin
  description: ''
  version: 2.4.5
servers:
  - url: https://identity.sandbox.lerian.net
security: []
tags:
  - name: Groups API
  - name: Applications API
  - name: Users API
  - name: MFA API
  - name: Providers API
  - name: Application Providers API
paths:
  /v1/groups:
    get:
      tags:
        - Groups API
      summary: List Groups
      description: Use this endpoint to list all predefined groups available in the system.
      parameters:
        - $ref: '#/components/parameters/PageQueryParam'
        - $ref: '#/components/parameters/LimitQueryParam'
      responses:
        '200':
          description: The list of all predefined groups available in the system.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Pagination'
                  - type: object
                    properties:
                      items:
                        type: array
                        items:
                          $ref: '#/components/schemas/GroupResponse'
              example:
                items:
                  - createdAt: '2025-04-08T08:01:30.169Z'
                    id: midaz-viewer-group
                    name: Midaz Viewer
                    users:
                      - johndoe
                      - janedoe
                  - createdAt: '2025-04-07T18:57:57.312Z'
                    id: midaz-editor-group
                    name: Midaz Editor
                    users:
                      - johnsmith
                page: 1
                limit: 10
                total: 2
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
              examples:
                Error1005:
                  $ref: '#/components/examples/Error1005'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
              examples:
                Error0006:
                  $ref: '#/components/examples/Error0006'
          headers: {}
      security:
        - bearer: []
components:
  parameters:
    PageQueryParam:
      name: page
      in: query
      description: The page number to retrieve.
      required: false
      schema:
        type: integer
        default: 1
        minimum: 1
    LimitQueryParam:
      name: limit
      in: query
      description: The maximum number of items to return per page. Cannot exceed 100.
      required: false
      schema:
        type: integer
        default: 10
        minimum: 1
        maximum: 100
  schemas:
    Pagination:
      description: Standard paginated response wrapper.
      type: object
      properties:
        items:
          type: array
          description: The list of items returned for the current page.
          items: {}
        page:
          type: integer
          description: The current page number.
          example: 1
        limit:
          type: integer
          description: The maximum number of items returned per page.
          example: 10
        total:
          type: integer
          description: The total number of items available across all pages.
          example: 2
    GroupResponse:
      description: >-
        Information of the group configured in the system, along with its
        metadata and assigned users.
      type: object
      properties:
        createdAt:
          type: string
          description: Timestamp of when the group was created.
        id:
          type: string
          description: Unique identifier of the group.
        name:
          type: string
          description: Display name of the group.
        users:
          type: array
          items:
            type: string
          description: List of users assigned to the group.
    ErrorMessage:
      description: The response message error.
      type: object
      properties:
        code:
          type: string
          description: A unique, stable identifier for the error.
        title:
          type: string
          description: A brief summary of the issue.
        message:
          type: string
          description: Detailed guidance for resolving the error.
  examples:
    Error1005:
      summary: No Groups Found
      value:
        code: IDE-1005
        title: No Groups Found
        message: No groups were found in the search.
    Error0006:
      summary: Internal Server Error
      value:
        code: IDE-0006
        title: Internal Server Error
        message: The server encountered an unexpected error. Please try again later.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: The authorization token in the 'Bearer <token>' format.

````