> ## 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.

# Retrieve a reporting group

> Retrieves detailed information about a specific reporting group, including its configuration and agent settings. Returns reporting group data matching the listing endpoint structure.



## OpenAPI

````yaml /en/api-reference/openapi.en-v1.json get /v1/organizations/{organization_id}/reporting-groups/{reporting_group_id}
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/{reporting_group_id}:
    get:
      tags:
        - Reporting Groups
      summary: Retrieve a reporting group
      description: >-
        Retrieves detailed information about a specific reporting group,
        including its configuration and agent settings. Returns reporting group
        data matching the listing endpoint structure.
      operationId: getReportingGroupById
      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: reporting_group_id
          in: path
          required: true
          schema:
            type: string
            maxLength: 24
            pattern: ^[0-9a-f]{24}$
          description: The unique identifier of the reporting group
          example: 507f1f77bcf86cd799439020
      responses:
        '200':
          description: >-
            Reporting group details retrieved successfully. The response
            includes the reporting group configuration and agent settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportingGroupByIdV1'
        '400':
          $ref: '#/components/responses/BadRequest'
          description: Invalid request - Invalid report group ID format
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: Unauthorized - authentication required
        '404':
          $ref: '#/components/responses/NotFound'
          description: Report group not found or does not belong to the organization
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ReportingGroupByIdV1:
      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 settings overridden at the reporting group level
        effective_agent_settings:
          $ref: '#/components/schemas/ReportingGroupEffectiveAgentSettingsV1'
          nullable: true
          description: >-
            Effective agent settings (combined from product configuration and
            overrides)
        execute_flexx_analyzer_agent:
          type: boolean
          description: If Flexx Analyzer agent execution is enabled
        intermediate_device_1_id:
          type: string
          nullable: true
          description: Workspace ID of the first intermediary device (searched by sysId)
        intermediate_device_2_id:
          type: string
          nullable: true
          description: Workspace ID of the second intermediary device (searched by sysId)
        intermediate_device_3_id:
          type: string
          nullable: true
          description: Workspace ID of the third intermediary device (searched by sysId)
      required:
        - id
        - name
        - execute_flexx_analyzer_agent
    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
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
            details:
              type: string
          required:
            - message
            - code
      required:
        - error
  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

````