List dashboards

Returns all dashboards the authenticated user can access in the project. Results include permission flags (canEdit, canShare, canDelete) and ownership metadata for each dashboard.

Filters only narrow the dashboards already available to the authenticated user and project-scoped access token. Use repeated tag parameters for exact tag matching and search for title/description text search.

Authorization

BearerAuth

AuthorizationBearer <token>

A project-scoped or dashboard-scoped access token. Generate one via the Token API using your project ID and project secret.

In: header

Query Parameters

tag?array<>

Exact dashboard tags to match. Repeat the parameter for multiple tags, for example ?tag=product:inbound-ticketing&tag=audience:operations. Comma-separated values are not supported.

Items1 <= items <= 20

tagMatch?string

Whether a dashboard must contain all supplied tags or any supplied tag. Requires at least one tag.

Default"all"

Value in"all" | "any"

kind?string

Return only dashboards or only Data Apps.

Value in"dashboard" | "data_app"

search?string

Case-insensitive search against dashboard title and description.

limit?integer

Maximum number of dashboards to return. Use a canonical unsigned base-10 integer from 1 through 500.

Default500

Range1 <= value <= 500

offset?integer

Number of matching dashboards to skip. Use a canonical unsigned base-10 safe integer.

Default0

Range0 <= value <= 9007199254740991

Response Body

`application/json`

curl -X get "https://semaphor.cloud/api/management/v1/dashboards"

{
  "dashboards": [
    {
      "id": "string",
      "kind": "string",
      "tags": [
        "string"
      ],
      "title": "string",
      "description": "string",
      "projectId": "string",
      "tenantId": "string",
      "isPrivate": true,
      "isPublic": true,
      "version": "string",
      "permissions": {
        "canEdit": true,
        "canShare": true,
        "canDelete": true
      },
      "ownership": {}
    }
  ],
  "total": 0,
  "organizationAppearance": {}
}

{
  "error": "string",
  "code": "string",
  "errorCode": "string",
  "details": {},
  "success": true
}

{
  "error": "string",
  "code": "string",
  "errorCode": "string",
  "details": {},
  "success": true
}

{
  "error": "string",
  "code": "string",
  "errorCode": "string",
  "details": {},
  "success": true
}

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`