Sign in
latestOpenAPI 3.0.12026-08-16171142480.4 KB

ff1699330afa

Dashboard API

Get a dashboard

get/rest/api/v1/projects/{projectId}/dashboards/{dashboardId}

Path parameters

projectIdstring uuid required
dashboardIdstring uuid required

Response

OK

createdAtstring date-time

Creation timestamp

descriptionstring

Optional description

idstring uuid

Unique identifier for the dashboard

isDefaultboolean

Whether this is the default dashboard

modifiedAtstring date-time

Last modification timestamp

namestring required

Dashboard name

projectIdstring uuid

Project ID this dashboard belongs to

sortOrderinteger

Display order in dashboard list

Example response

{
  "createdAt": "2026-01-15T10:30:00Z",
  "description": "My primary trading dashboard",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "isDefault": true,
  "modifiedAt": "2026-01-20T14:25:00Z",
  "name": "Main Dashboard",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "widgets": [
    {
      "gridsterItem": {
        "cols": 4,
        "dragEnabled": true,
        "maxItemCols": 12,
        "maxItemRows": 10,
        "minItemCols": 2,
        "minItemRows": 2,
        "resizeEnabled": true,
        "rows": 3
      },
      "id": "widget-001",
      "title": "Account Status"
    }
  ]
}