Skip to content
WorkRoad home
REST API

Replace the dashboard layout

PUT
/settings/dashboard

Sets which cards the dashboard shows, in order, and their sizes. A card listed twice is shown once.

Required scopes: settings:update

Authorization

headerAuthorizationBearer <token>

Request Body

application/json
  1. body
widgets*array<>

Every card to show, in order. Leave a card out to hide it.

Itemsitems <= 8
baseUpdatedAt?|

The updatedAt you read. When sent, a layout saved elsewhere since then fails with 409; null means no layout was saved yet. Leave it out to replace whatever is saved.

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PUT 'https://workroad.app/api/v1/settings/dashboard' \  -H 'Authorization: Bearer $WORKROAD_API_KEY' \  -H 'Content-Type: application/json' \  -d '{  "widgets": [    {      "id": "reviews",      "size": "single"    }  ]}'
Example Response
{  "data": {    "widgets": [      {        "id": "reviews",        "size": "single"      },      {        "id": "schedule",        "size": "wide"      },      {        "id": "tasks",        "size": "single"      }    ],    "updatedAt": "2026-02-01T12:00:00.000Z"  }}

Get task preferences GET

The task types the app offers and the colours of overdue and due tasks.

Resume notification email POST

Turns notification email back on after it was suppressed because a message bounced or was reported as spam.