Dashboard - Retrieves a list of dashboards

Retrieves a list of all available dashboards.

get

Authorizations

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Responses

200

Success: Successfully retrieved the list of dashboards.

text/plainapplication/jsontext/json

400

Bad Request: The request could not be processed due to invalid syntax or missing/incorrect parameters.

text/plainapplication/jsontext/json

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

403

Forbidden: Access denied to view the list of dashboards due to insufficient permissions or account restrictions.

text/plainapplication/jsontext/json

404

Not Found: The Dashboard was not found, the URL is invalid, or the resource has been deleted.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /dashboards HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "tenantId": "123e4567-e89b-12d3-a456-426614174000",
  "assetId": "123e4567-e89b-12d3-a456-426614174000",
  "assetType": "text",
  "assetName": "text",
  "embedUrl": "text",
  "webUrl": "text",
  "datasetId": "text",
  "bindedDatasetId": "text",
  "reportType": "text",
  "reportPages": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "isEffectiveIdentityRolesRequired": "text",
  "isEffectiveIdentityRequired": "text",
  "canView": true,
  "canCreate": true,
  "canEdit": true,
  "canExport": true,
  "createdOn": "2025-06-01T02:34:13.947Z",
  "modifiedOn": "2025-06-01T02:34:13.947Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "reportParameter": [
    "text"
  ]
}