SnozeDevelopers
API referenceOs widgets

Read the caller's native widget configuration

Returns the caller's configured shortcuts, pinned page, metric and home-screen charts for this workspace. Requires `workspace:read`. Always the caller's own row; there is no way to read another member's widget configuration.

GET
/v1/workspaces/{workspaceId}/widgets/settings

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.snoze.dev/v1/workspaces/string/widgets/settings'
Example Response
{  "data": {    "shortcuts": [      "home"    ],    "page": {      "itemId": "string",      "title": "string",      "kind": "string"    },    "metric": {      "databaseId": "string",      "databaseLabel": "string",      "aggregate": "count",      "fieldKey": "string",      "fieldLabel": "string",      "label": "string",      "display": "number",      "groupByFieldKey": "string",      "groupByFieldLabel": "string",      "chartColor": "string"    },    "charts": [      {        "id": "string",        "kind": "dashboard",        "itemId": "string",        "blockId": "string",        "title": "string",        "dashboardTitle": "string"      }    ]  }}