---
title: "Post List Dashboards"
method: POST
path: "/api/v1/dashboards/list"
tags: ["dashboards"]
---

# Post List Dashboards

`POST /api/v1/dashboards/list`

METHOD: POST
URL: /dashboard/list
ARGUMENTS: None
RETURNS: List of dashboards

## Query parameters

- `page` integer, nullable — The page number from which to start (0-based)
- `limit` integer — The maximum number of items to return
- `search_fields` DashboardProperties[] — String names of fields to search. Correspond by index to search field values
- `search_field_values` string[] — Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list
- `order_by` 'id' | 'name' | 'display_name' | 'rank' | 'label' — Names of dashboard fields supported for filtering/sorting on list endpoint.
- `order_by_direction` 'asc' | 'desc' — The direction in which to order list results, either ascending or descending.
- `fields` DashboardProperties[], nullable — The fields to include in the response
- `start_datetime` string, nullable — The start datetime for filtering results
- `end_datetime` string, nullable — The end datetime for filtering results

## Response `200`

Successful Response

- ListResponseDashboardResponse
  - `items` DashboardResponse[], required — List of items returned from the query
    - `name` string, required — Name of the dashboard
    - `display_name` string, required — Display name of the dashboard
    - `rank` integer, required — Dashboard importance (0 is the highest)
    - `label` string, required — Dashboard label. Typically "report" or "dashboard"
  - `page` integer, required — The page number of the results (0-based)
  - `page_size` integer, required — The number of items returned per page
  - `total_pages` integer, nullable — The total number of pages of results given the indicated page size
  - `total_count` integer, nullable — The total number of items returned from the query

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/asksyllable/apis/syllablesdk.md) · [All operations](https://skmtc.net/asksyllable/apis/syllablesdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/asksyllable/syllablesdk/versions/ac3228f980bb/schema)