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

# List Grid Reports

> Returns the grid reports for the workspace. The underlying route requires the Advanced Dashboards feature and the CAN_VIEW_REPORTING permission — the API key acts as its default user.

Returns the grid reports (Advanced Dashboards) configured for the workspace, wrapped as `data.gridReports`. Supports `offset` and `limit` query params. The underlying route requires the Advanced Dashboards feature plus the `CAN_VIEW_REPORTING` permission (inherited from the key's default user).


## OpenAPI

````yaml GET /api/v1/mgt/grid-reports
openapi: 3.1.0
info:
  title: Xenia Team API - List Grid Reports
  description: Returns the grid reports (Advanced Dashboards) configured for the workspace.
  version: 1.0.0
servers:
  - url: https://api.xenia.team
security: []
paths:
  /api/v1/mgt/grid-reports:
    get:
      tags:
        - Reporting
      summary: List Grid Reports
      description: >-
        Returns the grid reports for the workspace. The underlying route
        requires the Advanced Dashboards feature and the CAN_VIEW_REPORTING
        permission — the API key acts as its default user.
      parameters:
        - name: offset
          in: query
          required: false
          description: Row offset for paging.
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          required: false
          description: Maximum number of grid reports to return.
          schema:
            type: integer
            default: 100
      responses:
        '200':
          description: Grid reports retrieved successfully.
          content:
            application/json:
              example:
                data:
                  gridReports:
                    - id: 5a6b7c8d-9e0f-4123-8456-789012abcdef
                      WorkspaceId: cb363f7e-c52a-4478-911d-f6a6f791090e
                      name: Regional Compliance
                      description: Weekly rollup by region
                      viewOrder:
                        - b1c2d3e4-f5a6-4789-9012-3456789abcde
                      defaultView: b1c2d3e4-f5a6-4789-9012-3456789abcde
                      CreatedBy: dfea8b8a-5b22-4668-b68d-dc641eb3a101
                      UpdatedBy: dfea8b8a-5b22-4668-b68d-dc641eb3a101
                      DeletedBy: null
                      createdAt: '2025-05-01T10:00:00.000Z'
                      updatedAt: '2025-06-10T14:30:00.000Z'
                meta: {}
        '401':
          description: >-
            Unauthorized - Invalid client credentials, or client does not belong
            to this workspace.
        '403':
          description: 'Forbidden: API key not authorized for this route.'
        '500':
          description: Internal Server Error.
      security:
        - clientKey: []
          clientSecret: []
components:
  securitySchemes:
    clientKey:
      type: apiKey
      in: header
      name: x-client-key
    clientSecret:
      type: apiKey
      in: header
      name: x-client-secret

````