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

# List project dashboards

> Requires dashboard.read. Lists the project dashboards with their card layouts. A project without dashboards gets its default one on the first call.



## OpenAPI

````yaml https://api.trackup.me/openapi.json get /v1/projects/{id}/dashboards
openapi: 3.1.0
info:
  title: Trackup API
  description: >-
    API-key-accessible Trackup operations. Send your key in the `X-Api-Key`
    header.


    Keys belong to a team. `X-Team-Id` is not required; if supplied, it must
    match that team.


    Each operation lists its required key permission. The key creator must
    remain a team member and normally hold that permission. The ingest-only
    permissions `visitor.create`, `conversion.create`, and `request.create` do
    not need to be held by the creator.


    Project access and selection are described per operation. Session-only
    account, administration and OAuth operations are not part of this reference.


    The same operations are available as MCP tools at `/mcp` (Streamable HTTP).
    Authenticate with `X-Api-Key` or connect through OAuth, which issues an API
    key on consent.


    Schema validation errors return HTTP 422 with an `errors` object. Other
    errors generally contain `error` and `message`; operation-specific responses
    describe exceptions.
  version: 1.0.0
servers:
  - url: /
    description: Current API environment
security:
  - ApiKey: []
paths:
  /v1/projects/{id}/dashboards:
    get:
      tags:
        - Dashboards
      summary: List project dashboards
      description: >-
        Requires dashboard.read. Lists the project dashboards with their card
        layouts. A project without dashboards gets its default one on the first
        call.
      operationId: listProjectDashboards
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '200':
          description: Project dashboards.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardList'
        '401':
          description: The X-Api-Key header is missing or the API key is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: >-
            The key is expired, revoked, lacks permission, or its creator no
            longer has the required team access. A conflicting X-Team-Id is also
            rejected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            The requested resource was not found or is outside the permitted
            scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: >-
            Invalid input. Each field path maps to its first validation message;
            _form identifies an object-level error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '500':
          description: An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    DashboardList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Dashboard'
      required:
        - data
      example:
        data:
          - id: 12121212-1212-4121-8121-121212121212
            projectId: 11111111-1111-4111-8111-111111111111
            name: Conversions
            isDefault: false
            layout:
              cards:
                - type: sales_chart
                  x: 0
                  'y': 0
                  w: 8
                  h: 5
                - type: profit
                  x: 8
                  'y': 0
                  w: 4
                  h: 5
                - type: funnel
                  x: 0
                  'y': 5
                  w: 6
                  h: 8
                  config:
                    steps:
                      - page_view
                      - add_to_cart
                      - purchase
            createdAt: '2026-10-26T12:00:00.000Z'
            updatedAt: '2026-10-26T12:00:00.000Z'
    ApiError:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
      additionalProperties: true
    ValidationError:
      type: object
      properties:
        errors:
          type: object
          additionalProperties:
            type: string
      required:
        - errors
    Dashboard:
      type: object
      properties:
        id:
          type: string
          format: uuid
        projectId:
          type: string
          format: uuid
        name:
          type: string
        isDefault:
          type: boolean
        layout:
          type: object
          properties:
            cards:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - profit
                      - sales_chart
                      - achievement
                      - funnel
                      - payment_methods
                      - payment_status
                      - platform_share
                      - traffic_source_share
                      - geo
                      - accesses_total
                      - accesses_unique
                      - accesses_real
                      - accesses_bots
                      - clients_device
                      - clients_browser
                      - clients_os
                      - clients_utm
                      - clients_referrer
                      - revenue_utm
                      - top_pages
                      - link_accesses
                      - time_distribution
                  x:
                    type: integer
                  'y':
                    type: integer
                  w:
                    type: integer
                  h:
                    type: integer
                  config:
                    type: object
                    properties:
                      steps:
                        type: array
                        items:
                          type: string
                    required:
                      - steps
                required:
                  - type
                  - x
                  - 'y'
                  - w
                  - h
          required:
            - cards
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - projectId
        - name
        - isDefault
        - layout
        - createdAt
        - updatedAt
      example:
        id: 12121212-1212-4121-8121-121212121212
        projectId: 11111111-1111-4111-8111-111111111111
        name: Conversions
        isDefault: false
        layout:
          cards:
            - type: sales_chart
              x: 0
              'y': 0
              w: 8
              h: 5
            - type: profit
              x: 8
              'y': 0
              w: 4
              h: 5
            - type: funnel
              x: 0
              'y': 5
              w: 6
              h: 8
              config:
                steps:
                  - page_view
                  - add_to_cart
                  - purchase
        createdAt: '2026-10-26T12:00:00.000Z'
        updatedAt: '2026-10-26T12:00:00.000Z'
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Api-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.