---
title: "Read a shared dashboard's layout and annotation settings"
method: GET
path: "/embed/dashboards/config"
tags: ["Shared Links"]
---

# Read a shared dashboard's layout and annotation settings

`GET /embed/dashboards/config`

## Request

- Base URL: `https://api.speakai.co/v1`
- URL: `https://api.speakai.co/v1/embed/dashboards/config`
- Auth: none required

Read what a dashboard share link renders before any media is opened: its title, sections, widgets and `annotationSettings`, which lists the labels the "has label" filter may offer. No API key or access token: the `token` is the only credential. Changes to the dashboard's settings reach the link within about 15 seconds.

## Query parameters

- `token` string, required

## Response `200`

Success

- object
  - `status` 'success': `success` on every 2xx response.
  - `data` object: The dashboard's public layout. Only the keys relevant to labels and comments are listed here.
    - `title` string: Dashboard title.
    - `annotationSettings` object: What the link allows for labels and comments, resolved from the dashboard's settings.
      - `labels` object
        - `isEnabled` boolean: Whether labels are on.
        - `mode` 'view' | 'apply': `view` or `apply`.
        - `groups` object[]: The allowed label groups. Empty while labels are off.
          - `labelId` string
          - `name` string
        - `labels` object[]: Active labels of the allowed groups. Empty while labels are off.
          - `labelId` string: Id of the label.
          - `name` string: Name of the label.
          - `color` string: Hex colour, such as `#6366f1`.
          - `description` string: Description of the label.
          - `parentId` unknown
      - `comments` object
        - `isEnabled` boolean: Whether comments are on.
        - `mode` 'view' | 'reply': `view` or `reply`.
      - `reviewers` string[]: Names a viewer may write as, sent as `reviewerName`: the dashboard's feedback submitter names. Empty unless `apply` or `reply` mode is on.
      - `allowOtherReviewer` boolean: A viewer may also type a name that is not listed. True when the dashboard's `feedback.allowOtherSubmitter` is on and `apply` or `reply` mode is on.
    - `version` string: Changes whenever the dashboard changes.

## Other responses

- `404`: Unknown or revoked token

---

[API](https://skmtc.dev/speakai/apis/speak-ai-api.md) · [All operations](https://skmtc.dev/speakai/apis/speak-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/speakai/apis/speak-ai-api/revisions/52d777e6d46e?raw)