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

# List reporting groups

> Retrieve a paginated list of report groups belonging to the specified organization. Supports filtering and sorting on report group properties. Filters are provided as a JSON string following the AST structure of FilterNode. Results are returned in pages with pagination metadata.



## OpenAPI

````yaml /en/api-reference/openapi.en-v1.json get /v1/organizations/{organization_id}/reporting-groups
openapi: 3.0.3
info:
  title: Public Portal API
  version: 1.0.0
  description: Public REST API for portal
servers:
  - url: https://api.staging.flxwvdexternal.com
    description: Staging API server.
security:
  - bearerAuth: []
tags: []
paths:
  /v1/organizations/{organization_id}/reporting-groups:
    get:
      tags:
        - Reporting Groups
      summary: List reporting groups
      description: >-
        Retrieve a paginated list of report groups belonging to the specified
        organization. Supports filtering and sorting on report group properties.
        Filters are provided as a JSON string following the AST structure of
        FilterNode. Results are returned in pages with pagination metadata.
      operationId: listReportingGroups
      parameters:
        - name: organization id
          in: path
          required: true
          schema:
            type: string
            maxLength: 24
            pattern: ^[0-9a-f]{24}$
          description: The unique identifier of the organization
          example: 507f1f77bcf86cd799439011
        - name: page
          in: query
          required: false
          schema:
            type: integer
          description: 'Page number (default: 1)'
        - name: sort
          in: query
          required: false
          schema:
            type: string
          description: >-
            Sorting field with optional order suffix (:asc or :desc). Valid
            sorting fields: name, organization_id, product_config_id,
            fishing_pattern, fishing_pattern_field, patch_policy_target_id,
            policy_reporting_group, overridden_agent_settings.*,
            effective_agent_settings.*, execute_flexx_analyzer_agent,
            can_manage_agent_versions, intermediate_device_1_id,
            intermediate_device_2_id, intermediate_device_3_id. It defaults to
            ascending order if suffix is not provided.
        - name: fields
          in: query
          required: false
          schema:
            type: string
            maxLength: 2048
          description: >-
            Comma-separated list of fields to include in each report group
            element. Selectable fields: id, name, organization_id,
            product_config_id, fishing_pattern, fishing_pattern_field,
            patch_policy_target_id, policy_reporting_group,
            overridden_agent_settings, effective_agent_settings,
            execute_flexx_analyzer_agent, can_manage_agent_versions,
            flexx_agent_portal_download, intermediate_device_1_id,
            intermediate_device_2_id, intermediate_device_3_id. The id field is
            always included.
          example: name,effective_agent_settings,execute_flexx_analyzer_agent
        - name: filters
          in: query
          required: false
          schema:
            type: string
            maxLength: 5120
            description: >-
              Filter report groups using a JSON object. Specify the field to
              filter, comparison operator, and value. Example: {"field": "name",
              "op": "eq", "value": "Report Group 1"}
            example: '{"field": "name", "op": "eq", "value": "Report Group 1"}'
          description: >-
            Filter report groups by one or more criteria. Provide a JSON string
            with AST of filters. Filter by any field returned in the response.
            Use dot notation for nested fields:
            overridden_agent_settings.remote_support,
            effective_agent_settings.remote_support,
            effective_agent_settings.uninstall_protection, etc. Operators: eq,
            ne, gt, gte, lt, lte, in, nin, contains, startsWith, endsWith,
            between. Combine with and/or. Maximum length: 5120 characters.
          examples:
            simple:
              summary: Filter by report group name
              description: Returns reporting groups whose name contains the provided text.
              value: '{"field": "name", "op": "contains", "value": "production"}'
            complex-and:
              summary: Filter by nested configuration and execution flag
              description: >-
                Returns groups where uninstallation protection is disabled and
                analyzer execution is enabled.
              value: >-
                {"and": [{"field":
                "effective_agent_settings.uninstall_protection", "op": "eq",
                "value": "off"}, {"field": "execute_flexx_analyzer_agent", "op":
                "eq", "value": true}]}
            complex-or-and:
              summary: Combine OR and AND conditions
              description: >-
                Match multiple name patterns and require interactive remote
                support.
              value: >-
                {"and": [{"or": [{"field": "name", "op": "contains", "value":
                "prod"}, {"field": "name", "op": "contains", "value":
                "stage"}]}, {"field": "effective_agent_settings.remote_support",
                "op": "eq", "value": "INTERACTIVE"}]}
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            default: 100
            maximum: 100
            minimum: 1
          description: Number of items per page
      responses:
        '200':
          description: >-
            Paginated list of report groups successfully retrieved. The response
            includes pagination metadata and the report group data array.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportingGroupListItemV1ListResponseV1'
        '400':
          $ref: '#/components/responses/BadRequest'
          description: >-
            Bad Request. Common Causes: - Invalid pagination parameters -
            Invalid sorting parameter - Invalid filter parameters
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: Unauthorized - authentication required
        '404':
          $ref: '#/components/responses/NotFound'
          description: Organization not found
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ReportingGroupListItemV1ListResponseV1:
      type: object
      properties:
        has_next:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/ReportingGroupListItemV1'
      required:
        - has_next
        - data
    ReportingGroupListItemV1:
      type: object
      properties:
        id:
          type: string
          description: Reporting group Id
        name:
          type: string
          description: Name of the reporting group
        organization_id:
          type: string
          nullable: true
          description: Organization identifier
        product_config_id:
          type: string
          nullable: true
          description: Product configuration identifier
        fishing_pattern:
          type: string
          nullable: true
          description: Fishing pattern name
        fishing_pattern_field:
          type: string
          enum:
            - full_name
            - description
            - ou
            - current_subnet
          nullable: true
          description: >-
            Field to which fishing_pattern is applied. Possible values:
            full_name, description, ou, current_subnet.
        patch_policy_target_id:
          type: string
          nullable: true
          description: Patch policy target identifier
        policy_reporting_group:
          type: string
          nullable: true
          description: Policy reporting group identifier
        overridden_agent_settings:
          $ref: '#/components/schemas/ReportingGroupAgentSettingsV1'
          nullable: true
          description: Agent configuration overridden at the reporting group level
        effective_agent_settings:
          $ref: '#/components/schemas/ReportingGroupEffectiveAgentSettingsV1'
          nullable: true
          description: Effective agent settings
        execute_flexx_analyzer_agent:
          type: boolean
          description: If the execution of the FlexxAnalyzer agent is enabled
        can_manage_agent_versions:
          type: boolean
          description: >-
            Indicates if the report group allows self-management of agent
            versions according to its associated product configuration
        flexx_agent_portal_download:
          type: boolean
          description: >-
            If FlexxAgent download from the portal is enabled for the group
            organization
        intermediate_device_1_id:
          type: string
          nullable: true
          description: Workspace ID of the first intermediary device
        intermediate_device_2_id:
          type: string
          nullable: true
          description: Workspace ID of the second intermediary device
        intermediate_device_3_id:
          type: string
          nullable: true
          description: Workspace ID of the third intermediary device
      required:
        - id
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
            details:
              type: string
          required:
            - message
            - code
      required:
        - error
    ReportingGroupAgentSettingsV1:
      type: object
      properties:
        remote_support:
          type: string
          nullable: true
          description: Remote support configuration
        collect_device_location:
          type: boolean
          nullable: true
          description: If device location collection is enabled
        auto_update_agents:
          type: boolean
          nullable: true
          description: If automatic agent updates are enabled
        collect_event_logs:
          type: boolean
          nullable: true
          description: If event log collection is enabled
        event_log_ids:
          type: string
          nullable: true
          description: Event log record IDs
        event_logs_recurrence:
          type: number
          nullable: true
          description: Event logs recurrence
        collect_disks:
          type: boolean
          nullable: true
          description: If disk collection is enabled
        collect_services:
          type: boolean
          nullable: true
          description: If service collection is enabled
        collect_pnp_events:
          type: boolean
          nullable: true
          description: If PnP event collection is enabled
        collect_public_ip:
          type: boolean
          nullable: true
          description: If public IP collection is enabled
        fra_system_actions_role:
          type: string
          nullable: true
          description: FRA system actions role
        unified_reporting:
          type: string
          nullable: true
          description: Unified reporting configuration
        unified_operations:
          type: string
          nullable: true
          description: Unified operations configuration
        uninstall_protection:
          type: string
          nullable: true
          enum:
            - 'off'
            - 'on'
          description: 'Possible values: off, on. Returns null if no applicable status.'
        web_apps:
          type: boolean
          nullable: true
          description: If web apps are enabled
    ReportingGroupEffectiveAgentSettingsV1:
      type: object
      description: >-
        Effective agent settings (includes product configuration fields plus
        overrides)
      properties:
        remote_support:
          type: string
          nullable: true
        collect_device_location:
          type: boolean
          nullable: true
        auto_update_agents:
          type: boolean
          nullable: true
        collect_event_logs:
          type: boolean
          nullable: true
        event_log_ids:
          type: string
          nullable: true
        event_logs_recurrence:
          type: number
          nullable: true
        collect_disks:
          type: boolean
          nullable: true
        collect_services:
          type: boolean
          nullable: true
        collect_pnp_events:
          type: boolean
          nullable: true
        collect_public_ip:
          type: boolean
          nullable: true
        fra_system_actions_role:
          type: string
          nullable: true
        unified_reporting:
          type: string
          nullable: true
        uninstall_protection:
          type: string
          nullable: true
          enum:
            - 'off'
            - 'on'
          description: 'Possible values: off, on. Returns null if no applicable status.'
        resources_report_recurrence:
          type: number
          nullable: true
        profile_storage_report_recurrence:
          type: number
          nullable: true
        sync_broker_recurrence:
          type: number
          nullable: true
        detect_new_citrix_subscriptions:
          type: boolean
          nullable: true
        proxy_type:
          type: string
          nullable: true
        can_enable_flexx_agent_per_group:
          type: boolean
          nullable: true
        web_apps:
          type: boolean
          nullable: true
        fra_simplified_security:
          type: string
          nullable: true
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: Too Many Requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````