> ## Documentation Index > Fetch the complete documentation index at: https://docs.dados.rio/llms.txt > Use this file to discover all available pages before exploring further. # List all groups > List all groups in the system with optional filtering. **Filtering**: Use the `prefix` query parameter to filter groups by name prefix. **Authorization**: All authenticated users can list groups. **Performance**: Results are cached for optimal performance. Large result sets may be paginated in future versions. **Use Cases**: - Display all available groups in admin interfaces - Search for specific groups by name prefix - Export group information for reporting ## OpenAPI ````yaml https://raw.githubusercontent.com/prefeitura-rio/heimdall/main/docs/api/openapi.json get /api/v1/groups/ openapi: 3.1.0 info: title: Heimdall Admin Service description: >- # Heimdall Admin Service API A comprehensive admin service for user and group management with authorization powered by Cerbos. ## Features - **User Management**: Automatic user creation from JWT tokens with role-based access control - **Group Management**: Create, manage, and assign users to groups with hierarchical permissions - **Role Management**: Define and assign roles to users and groups - **Mapping Management**: Configure API endpoint to action mappings for authorization - **Action Management**: Define available actions for fine-grained permission control - **Cerbos Integration**: Policy-based authorization with external Cerbos service - **Audit Logging**: Comprehensive audit trail for all administrative operations - **Redis Caching**: High-performance caching for frequently accessed data version: 1.0.0 servers: - url: https://services.pref.rio/heimdall-admin description: Production server - url: https://services.staging.app.dados.rio/heimdall-admin description: Staging server security: [] tags: - name: health description: Service health and readiness checks - name: users description: >- User management operations. Users are automatically created from JWT tokens. - name: groups description: >- Group management operations. Groups organize users and can have roles assigned. - name: memberships description: Group membership management. Assign and remove users from groups. - name: roles description: >- Role management operations. Roles define permissions that can be assigned to users or groups. - name: actions description: >- Action management operations. Actions define the granular permissions available in the system. - name: mappings description: >- API endpoint to action mapping configuration. Maps HTTP endpoints to authorization actions. paths: /api/v1/groups/: get: tags: - groups summary: List all groups description: >- List all groups in the system with optional filtering. **Filtering**: Use the `prefix` query parameter to filter groups by name prefix. **Authorization**: All authenticated users can list groups. **Performance**: Results are cached for optimal performance. Large result sets may be paginated in future versions. **Use Cases**: - Display all available groups in admin interfaces - Search for specific groups by name prefix - Export group information for reporting operationId: list_groups_api_v1_groups__get parameters: - name: prefix in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter groups by name prefix (case-insensitive) title: Prefix description: Filter groups by name prefix (case-insensitive) example: eng responses: '200': description: List of groups retrieved successfully content: application/json: schema: type: array items: $ref: '#/components/schemas/GroupResponse' title: Response List Groups Api V1 Groups Get example: - id: 1 name: engineering_team:backend description: Engineering team with access to development resources created_by: '12345678901' created_at: '2024-01-15T10:30:00Z' - id: 2 name: marketing_team:frontend description: Marketing team for campaign management created_by: '98765432109' created_at: '2024-01-16T14:20:00Z' '401': description: Unauthorized - Invalid or missing JWT token content: application/json: example: detail: Could not validate credentials '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '500': description: Internal server error content: application/json: example: detail: An unexpected error occurred while retrieving groups security: - HTTPBearer: [] components: schemas: GroupResponse: properties: id: type: integer title: Id description: Unique identifier for the group example: 1 name: type: string title: Name description: Group name example: engineering_team:backend description: type: string title: Description description: Group description example: Engineering team with access to development resources created_by: anyOf: - type: string - type: 'null' title: Created By description: CPF of the user who created this group example: '12345678901' created_at: type: string title: Created At description: ISO timestamp when the group was created example: '2024-01-15T10:30:00Z' type: object required: - id - name - description - created_at title: GroupResponse description: Response model for group information. example: created_at: '2024-01-15T10:30:00Z' created_by: '12345678901' description: Engineering team with access to development resources id: 1 name: engineering_team:backend HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError securitySchemes: HTTPBearer: type: http scheme: bearer ````