Skip to main content
GET
/
dashboards
List dashboards in workspace
curl --request GET \
  --url https://api.akua.dev/v1/dashboards \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "j572abc123def456",
      "name": "Cluster Overview",
      "description": "<string>",
      "workspace_id": "<string>",
      "widgets": [
        {
          "id": "<string>",
          "dashboard_id": "<string>",
          "snippet_id": "<string>",
          "position": 123,
          "created_at": 1,
          "updated_at": 1,
          "etag": "<string>"
        }
      ],
      "created_by": "<string>",
      "created_at": 1,
      "updated_at": 1,
      "etag": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.akua.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Query Parameters

​
cursor
string

Pagination cursor from a previous response's next_cursor.

​
limit
integer
default:50

Items per page (1-100, default 50)

Required range: 1 <= x <= 100
Example:

50

Response

List of dashboards

​
data
object[]
required
​
has_more
boolean
required

True if more items exist after this page.

​
next_cursor
string | null
required

Opaque cursor for the next page, or null if no more pages.