Returns the dashboards of 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>" \
>      -H "Content-Type: application/json"

200Retrieved

1 [
2   {
3     "id": "a1b2c3d4-e5f6-7890-ab12-cdef34567890",
4     "userId": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
5     "createdOn": "2024-04-10T08:15:00Z",
6     "updatedOn": "2024-05-01T12:45:00Z",
7     "widgets": [
8       {
9         "id": "9f8e7d6c-5b4a-3210-fedc-ba9876543210",
10         "type": "task-views",
11         "name": "Unassigned Tasks",
12         "entityId": "3c2b1a09-8f7e-6d5c-b4a3-210fedcba987",
13         "filterId": "0a1b2c3d-4e5f-6789-0abc-def123456789",
14         "createdOn": "2024-04-10T08:15:00Z",
15         "createdBy": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
16         "updatedOn": "2024-05-01T12:45:00Z",
17         "updatedBy": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
18         "column": 1,
19         "order": 2,
20         "settings": "{ \"showPrivate\": true }",
21         "value": null
22       }
23     ]
24   }
25 ]

Returns the dashboards of the current user.

Required Permissions

The user must be the creator.

Returns the dashboards of the current user. <Check title="Required Permissions" icon="key">The user must be the creator.</Check>

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.