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

# List dashboards

> List dashboards for your organization.



## OpenAPI

````yaml /api-reference/v1/dashboards-v1.yaml get /dashboards
openapi: 3.0.3
info:
  title: Coval Dashboards API
  version: 1.0.0
  description: |
    Create and manage dashboards and widgets for visualizing evaluation metrics.
  contact:
    name: Coval API Support
    email: support@coval.dev
    url: https://docs.coval.ai
  license:
    name: Proprietary
    url: https://coval.dev/terms
servers:
  - url: https://api.coval.dev/v1
    description: Production API
security:
  - ApiKeyAuth: []
tags:
  - name: Dashboards
    description: Dashboard CRUD operations
  - name: Widgets
    description: Dashboard widget CRUD operations
paths:
  /dashboards:
    get:
      tags:
        - Dashboards
      summary: List dashboards
      description: List dashboards for your organization.
      operationId: listDashboards
      parameters:
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: Maximum number of results per page
        - name: page_token
          in: query
          required: false
          schema:
            type: string
          description: Opaque pagination token from previous response
        - name: order_by
          in: query
          required: false
          schema:
            type: string
            example: '-create_time'
          description: >-
            Sort field and direction. Prefix with - for descending (e.g.
            -create_time).
      responses:
        '200':
          description: Dashboards retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDashboardsResponse'
              examples:
                success:
                  $ref: '#/components/examples/ListDashboardsSuccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ListDashboardsResponse:
      type: object
      required:
        - dashboards
      properties:
        dashboards:
          type: array
          items:
            $ref: '#/components/schemas/DashboardResource'
        next_page_token:
          type: string
          nullable: true
          description: Token for fetching next page (null if no more results)
    DashboardResource:
      type: object
      description: Dashboard resource
      required:
        - name
        - create_time
        - update_time
      properties:
        name:
          type: string
          description: Resource name in format `dashboards/{id}`
          example: dashboards/abc123def456ghi789jklm
        display_name:
          type: string
          nullable: true
          maxLength: 255
          description: Human-readable dashboard name
          example: Production Metrics
        description:
          type: string
          nullable: true
          description: Free-text dashboard description
          example: Production monitoring metrics
        is_default:
          type: boolean
          description: >-
            Whether this is the organization's default dashboard (the one shown
            when no dashboard is specified)
          example: true
        is_favorite:
          type: boolean
          description: Whether the dashboard is marked as a favorite
          example: false
        position:
          type: integer
          description: Ordering position within the organization's dashboards
          example: 0
        config:
          type: object
          nullable: true
          additionalProperties: true
          description: Free-form JSON config blob (e.g. saved date preferences)
        create_time:
          type: string
          format: date-time
          description: Creation timestamp (ISO 8601)
          example: '2025-10-14T12:00:00Z'
        update_time:
          type: string
          format: date-time
          description: Last update timestamp (ISO 8601)
          example: '2025-10-15T14:30:00Z'
    ErrorResponse:
      type: object
      description: Standard error response
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
              description: Error code
              enum:
                - INVALID_ARGUMENT
                - UNAUTHENTICATED
                - NOT_FOUND
                - INTERNAL
              example: INVALID_ARGUMENT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameter
            details:
              type: array
              description: Detailed error information
              items:
                type: object
                properties:
                  field:
                    type: string
                    nullable: true
                    description: Field that caused the error
                  description:
                    type: string
                    description: Detailed error description
  examples:
    ListDashboardsSuccess:
      summary: Successful list response
      value:
        dashboards:
          - name: dashboards/abc123def456ghi789jklm
            display_name: Production Metrics
            create_time: '2025-10-14T12:00:00Z'
            update_time: '2025-10-15T14:30:00Z'
          - name: dashboards/xyz789abc012def345ghij
            display_name: Voice Agent Quality
            create_time: '2025-10-13T08:00:00Z'
            update_time: '2025-10-13T08:00:00Z'
        next_page_token: null
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: INVALID_ARGUMENT
              message: Invalid request body
              details:
                - field: display_name
                  description: display_name must be between 1 and 255 characters
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: UNAUTHENTICATED
              message: Authentication failed
              details:
                - field: X-API-Key
                  description: Invalid or missing API key
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: INTERNAL
              message: Internal server error
              details:
                - description: An unexpected error occurred
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication

````