Skip to main content
GET
/
v1
/
dashboards
List dashboards in workspace
curl --request GET \
  --url https://api.cnap.tech/v1/dashboards \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "j572abc123def456",
      "name": "Cluster Overview",
      "description": "<string>",
      "workspace_id": "<string>",
      "widgets": [
        {
          "snippet_id": "<string>",
          "col_span": 2,
          "display_type": "table"
        }
      ],
      "created_by": "<string>",
      "created_at": 123
    }
  ],
  "pagination": {
    "cursor": "<string>",
    "has_more": true
  }
}

Authorizations

Authorization
string
header
required

Personal Access Token (cnap_pat_...) or OAuth2 JWT. Create tokens at https://cnap.tech/account/tokens

Query Parameters

cursor
string

Pagination cursor from previous response

limit
integer
default:50

Items per page (1-100)

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

50

Response

List of dashboards

data
object[]
required
pagination
object
required