POST
/
api
/
v1
/
dashboards
/
list
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.v1.postListDashboard({});

  // Handle the result
  console.log(result);
}

run();
{
  "items": [
    {
      "name": "<string>",
      "display_name": "<string>",
      "rank": 123,
      "label": "<string>"
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_pages": 123,
  "total_count": 123
}

Authorizations

​
Syllable-API-Key
string
header
required

Query Parameters

​
page
integer | null
default:0
Required range: x >= 0
​
limit
integer
default:25
Required range: x >= 0
​
search_fields
enum<string>[]
Available options:
id,
name,
display_name,
rank,
label
​
search_field_values
string[]
​
order_by
enum<string> | null
Available options:
id,
name,
display_name,
rank,
label
​
order_by_direction
enum<string> | null
Available options:
asc,
desc
​
fields
enum<string>[] | null
Available options:
id,
name,
display_name,
rank,
label
​
start_datetime
string | null
​
end_datetime
string | null

Response

200
application/json
Successful Response
​
items
object[]
required

Basic information about a dashboard with a description.

​
page
integer
required
​
page_size
integer
required
​
total_pages
integer | null
​
total_count
integer | null
Download Directory MembersPost Fetch Info