SaaSFlow
DevelopersAPIReferencedashboards

List dashboards

List the custom dashboards shared with the person, with their access and the link to open each one. Entries are left out; dashboards_get has them.

Authentication

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

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

Response Body

Dashboards shared with the person

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.saasflow.com/companies/string/dashboards'
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"  }]

List dashboard widgets

List the widgets a custom dashboard can hold: id, name, category, a one-line description, the default size on the 12-column grid, and the permissions a…

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…