SaaSFlow
DevelopersAPIReferencedashboards

Retrieve dashboard

Retrieve one dashboard with its entries: widget ids and section headlines with their grid position (x and w in columns of 12, y and h in rows).

Authentication

Checking whether you're signed in…
GET
/companies/{companyId}/dashboards/{dashboardId}

Authorization

headerAuthorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

Path Parameters

companyId*string
Length1 <= length
dashboardId*string
Length1 <= length

Response Body

The dashboard

application/json
  1. response
id*string
name*string
position*number
right*string

The person's access: viewer reads, editor also changes name and layout, owner also deletes.

Value in"viewer""editor""owner"
entries?array<|>
url*string

Where the person opens it in the app.

lastUpdatedTime*string|null
Example Request
curl -X GET 'https://api.saasflow.com/companies/string/dashboards/string'
Example Response
{  "id": "string",  "name": "string",  "position": 0,  "right": "viewer",  "entries": [    {      "type": "text",      "id": "string",      "text": "string",      "subText": "string",      "x": 0,      "y": 0,      "w": 0,      "h": 0    }  ],  "url": "string",  "lastUpdatedTime": "string"}

Create dashboard

Create a custom dashboard owned by the person, for example a board meeting view or a cash overview. Pick widgets from dashboard_widgets_list and add…

Update dashboard

Rename a dashboard or replace its entries. entries replaces the whole list, so read the dashboard first and send it back with your changes; entries you…