Look up a dashboard
curl --request GET \
--url https://api.upsolve.ai/v2/api/dashboards/{dashboardId} \
--header 'authorization: <api-key>'import requests
url = "https://api.upsolve.ai/v2/api/dashboards/{dashboardId}"
headers = {"authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<api-key>'}};
fetch('https://api.upsolve.ai/v2/api/dashboards/{dashboardId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.upsolve.ai/v2/api/dashboards/{dashboardId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.upsolve.ai/v2/api/dashboards/{dashboardId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.upsolve.ai/v2/api/dashboards/{dashboardId}")
.header("authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upsolve.ai/v2/api/dashboards/{dashboardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"applicationId": "<string>",
"dashboardId": "<string>",
"name": "<string>",
"kind": "template",
"legacyDashboardId": "<string>"
}
}{
"status": "error",
"error": {
"message": "<string>",
"code": "<string>",
"details": {}
}
}API v2: Applications & Dashboards
Look Up Dashboard
Returns the application a dashboard belongs to, and its v2 ID. Accepts a migrated v1 dashboard ID as well, so an integration that only stored v1 IDs can build the /share/application/?dashboardId= iframe URL. Authenticate with an Upsolve API key or a project-user token (from /v1/api/projects/user-token, or /v1/api/tenant/register-tenant after migration).
GET
/
v2
/
api
/
dashboards
/
{dashboardId}
Look up a dashboard
curl --request GET \
--url https://api.upsolve.ai/v2/api/dashboards/{dashboardId} \
--header 'authorization: <api-key>'import requests
url = "https://api.upsolve.ai/v2/api/dashboards/{dashboardId}"
headers = {"authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<api-key>'}};
fetch('https://api.upsolve.ai/v2/api/dashboards/{dashboardId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.upsolve.ai/v2/api/dashboards/{dashboardId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.upsolve.ai/v2/api/dashboards/{dashboardId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.upsolve.ai/v2/api/dashboards/{dashboardId}")
.header("authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upsolve.ai/v2/api/dashboards/{dashboardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"applicationId": "<string>",
"dashboardId": "<string>",
"name": "<string>",
"kind": "template",
"legacyDashboardId": "<string>"
}
}{
"status": "error",
"error": {
"message": "<string>",
"code": "<string>",
"details": {}
}
}Authorizations
Path Parameters
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
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:
1The ID of the organization. Required when using Supabase JWT authentication.
The ID of the connection a guest has access to
Was this page helpful?