Skip to main content
GET
Look up a dashboard

Authorizations

authorization
string
header
required

Path Parameters

dashboardId
string<uuid>
required

A v2 dashboard ID, or the ID of a v1 dashboard that has been migrated.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Query Parameters

apiKey
string

Upsolve API key, generated under Account → Developer settings in the Upsolve Hub. Keys are user-scoped: pass organizationId alongside the key to select which org to act on.

Minimum string length: 1
organizationId
string

The ID of the organization. Required when using Supabase JWT authentication.

connectionId
string

The ID of the connection a guest has access to

Response

GET /v2/api/dashboards/:dashboardId Positive response

status
string
required
Allowed value: "success"
data
object
required