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

# List Dashboards

> List all dashboards with optional filtering and pagination

# List Dashboards

List all dashboards with optional filtering and pagination.

## Query Parameters

<ParamField query="service" type="string">
  Filter by dashboard service fully qualified name.
</ParamField>

<ParamField query="limit" type="integer" default="10">
  Maximum number of results to return (max: 1000000).
</ParamField>

<ParamField query="before" type="string">
  Cursor for backward pagination.
</ParamField>

<ParamField query="after" type="string">
  Cursor for forward pagination.
</ParamField>

<ParamField query="fields" type="string">
  Comma-separated list of fields to include: `owners`, `tags`, `followers`, `votes`, `extension`, `domains`, `charts`, `sourceHash`. See [Supported Fields](#supported-fields) below.
</ParamField>

<ParamField query="include" type="string" default="non-deleted">
  Include `all`, `deleted`, or `non-deleted` entities.
</ParamField>

<RequestExample dropdown>
  ```python GET /v1/dashboards theme={null}
  from metadata.sdk import configure
  from metadata.sdk.entities import Dashboards

  configure(
      host="https://your-company.open-metadata.org/api",
      jwt_token="your-jwt-token"
  )

  # List first page
  dashboards = Dashboards.list(limit=50)
  for d in dashboards.data:
      print(f"{d.fullyQualifiedName}")

  # List all with auto-pagination
  for d in Dashboards.list_all():
      print(f"{d.fullyQualifiedName}")

  # Filter by service
  dashboards = Dashboards.list(
      service="sample_superset",
      fields=["owners", "tags", "charts"],
      limit=50
  )

  for d in dashboards.data:
      print(f"{d.fullyQualifiedName}")
      if d.owners:
          print(f"  Owners: {[o.name for o in d.owners]}")
      if d.tags:
          print(f"  Tags: {[t.tagFQN for t in d.tags]}")
  ```

  ```java GET /v1/dashboards theme={null}
  import static org.openmetadata.sdk.fluent.Dashboards.*;

  // List first page
  var result = Dashboards.list()
      .limit(50)
      .execute();

  for (var d : result.getData()) {
      System.out.println(d.getFullyQualifiedName());
  }

  // Filter by service with fields
  var result = Dashboards.list()
      .service("sample_superset")
      .fields("owners", "tags", "charts")
      .limit(50)
      .execute();

  for (var d : result.getData()) {
      System.out.println(d.getFullyQualifiedName());
  }
  ```

  ```bash GET /v1/dashboards theme={null}
  # List all
  curl "{base_url}/api/v1/dashboards?limit=50" \
    -H "Authorization: Bearer {access_token}"

  # Filter by service
  curl "{base_url}/api/v1/dashboards?service=sample_superset&limit=50" \
    -H "Authorization: Bearer {access_token}"

  # With fields
  curl "{base_url}/api/v1/dashboards?service=sample_superset&fields=owners,tags,charts,domains&limit=50" \
    -H "Authorization: Bearer {access_token}"
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": [
      {
        "id": "03fb5cc3-de48-423f-9926-8e192e5de59d",
        "name": "10",
        "displayName": "deck.gl Demo",
        "fullyQualifiedName": "sample_superset.10",
        "description": "",
        "version": 0.1,
        "updatedAt": 1769982666437,
        "updatedBy": "admin",
        "sourceUrl": "http://localhost:808/superset/dashboard/10/",
        "service": {
          "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
          "type": "dashboardService",
          "name": "sample_superset",
          "fullyQualifiedName": "sample_superset",
          "deleted": false
        },
        "serviceType": "Superset",
        "href": "http://localhost:8585/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d",
        "deleted": false,
        "owners": [],
        "tags": [],
        "followers": [],
        "votes": {
          "upVotes": 0,
          "downVotes": 0
        },
        "domains": [],
        "charts": [
          {
            "id": "chart-id",
            "type": "chart",
            "name": "114",
            "displayName": "# of Games"
          }
        ]
      }
    ],
    "paging": {
      "after": "...",
      "total": 5
    }
  }
  ```
</ResponseExample>

***

## Returns

Returns a paginated list of dashboard objects. By default, only basic fields are included. Use the `fields` parameter to request additional data.

## Response

<ResponseField name="data" type="array">
  Array of dashboard objects.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      Unique identifier for the dashboard (UUID format).
    </ResponseField>

    <ResponseField name="name" type="string">
      Dashboard name.
    </ResponseField>

    <ResponseField name="fullyQualifiedName" type="string">
      Fully qualified name in format `service.dashboardName`.
    </ResponseField>

    <ResponseField name="displayName" type="string">
      Human-readable display name.
    </ResponseField>

    <ResponseField name="service" type="object">
      Reference to the parent dashboard service.
    </ResponseField>

    <ResponseField name="serviceType" type="string">
      Type of dashboard service (e.g., Superset, Looker, Tableau).
    </ResponseField>

    <ResponseField name="sourceUrl" type="string">
      URL of the dashboard in the source system.
    </ResponseField>

    <ResponseField name="charts" type="array" optional>
      Charts associated with the dashboard. Only included when `fields` contains `charts`.
    </ResponseField>

    <ResponseField name="owners" type="array" optional>
      List of owners assigned to the dashboard. Only included when `fields` contains `owners`.
    </ResponseField>

    <ResponseField name="tags" type="array" optional>
      Classification tags applied. Only included when `fields` contains `tags`.
    </ResponseField>

    <ResponseField name="domains" type="array" optional>
      Domain assignments for governance. Only included when `fields` contains `domains`.
    </ResponseField>

    <ResponseField name="followers" type="array" optional>
      Users following this dashboard. Only included when `fields` contains `followers`.
    </ResponseField>

    <ResponseField name="votes" type="object" optional>
      User votes and ratings. Only included when `fields` contains `votes`.
    </ResponseField>

    <ResponseField name="extension" type="object" optional>
      Custom properties. Only included when `fields` contains `extension`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="paging" type="object">
  Pagination information.

  <Expandable title="properties">
    <ResponseField name="total" type="integer">
      Total count of dashboards matching the query.
    </ResponseField>

    <ResponseField name="after" type="string" optional>
      Cursor for the next page of results. Null if this is the last page.
    </ResponseField>

    <ResponseField name="before" type="string" optional>
      Cursor for the previous page of results. Null if this is the first page.
    </ResponseField>
  </Expandable>
</ResponseField>

***

## Supported Fields

The following fields can be requested via the `fields` query parameter:

| Field        | Description                          |
| ------------ | ------------------------------------ |
| `owners`     | Owner references (users and teams)   |
| `tags`       | Classification tags                  |
| `followers`  | Users following the dashboard        |
| `votes`      | User votes and ratings               |
| `extension`  | Custom property values               |
| `domains`    | Domain assignments for governance    |
| `charts`     | Charts associated with the dashboard |
| `sourceHash` | Hash for change detection            |

***

## Error Handling

| Code  | Error Type     | Description                              |
| ----- | -------------- | ---------------------------------------- |
| `401` | `UNAUTHORIZED` | Invalid or missing authentication token  |
| `403` | `FORBIDDEN`    | User lacks permission to list dashboards |