Returns dashboards for the current user.

GET

https://api.awork.com/api/v1/me/dashboards

GET

/api/v1/me/dashboards

curl https://api.awork.com/api/v1/me/dashboards \
     -H "Authorization: Bearer <token>"

200Retrieved

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "createdOn": "2024-01-15T09:30:00Z",
    "updatedOn": "2024-01-15T09:30:00Z",
    "widgets": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "task-views",
        "name": "Unassigned Tasks",
        "entityId": "123e4567-e89b-12d3-a456-426614174000",
        "filterId": "123e4567-e89b-12d3-a456-426614174000",
        "createdOn": "2024-01-15T09:30:00Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000",
        "updatedOn": "2024-01-15T09:30:00Z",
        "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
        "column": 0,
        "order": 0,
        "settings": "{ \"showPrivate\": true }",
        "value": null
      }
    ]
  }
]

Returns dashboards for the current user. Set includeWidgets to include widget details. A default dashboard is created when none exists.

Required Permissions

The user must be the creator.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

includeWidgetsbooleanOptionalDefaults to false

Include widgets.

Response

idstringOptionalformat: "uuid"

The id of the dashboard.

userIdstringOptionalformat: "uuid"

The id of the user that the dashboard belongs to.

createdOnstringOptionalformat: "date-time"

The creation date.

updatedOnstringOptionalformat: "date-time"

The date when the entity was last updated.

widgetslist of objects or nullOptional

A list of all widgets of the dashboard.