Preview the consent screen for a scope request
curl --request GET \
--url https://api.orbit.devotel.io/api/v1/developers/oauth/consent-preview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.orbit.devotel.io/api/v1/developers/oauth/consent-preview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orbit.devotel.io/api/v1/developers/oauth/consent-preview', 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.orbit.devotel.io/api/v1/developers/oauth/consent-preview",
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: Bearer <token>"
],
]);
$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.orbit.devotel.io/api/v1/developers/oauth/consent-preview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.orbit.devotel.io/api/v1/developers/oauth/consent-preview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/developers/oauth/consent-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"requested": [
"messages:read",
"contacts:write",
"admin"
],
"granted": [
"messages:read",
"contacts:write"
],
"rejected": [
"admin"
],
"consent": [
{
"scope": "messages:read",
"label": "Read messages",
"consent": "View your messages and their delivery status.",
"sensitive": false
},
{
"scope": "contacts:write",
"label": "Manage contacts",
"consent": "Create and update contacts in your workspace.",
"sensitive": false
}
]
},
"meta": {
"request_id": "req_9c8f2a1b",
"timestamp": "2026-08-08T12:00:00.000Z"
}
}Developer
Preview the consent screen for a scope request
Renders the install/consent-screen rows for a space-delimited scope request and flags any scopes outside the grantable catalog (which a real authorization request would reject). Use it to preview exactly what a customer will see and approve before you point them at the authorization endpoint. Requires an authenticated owner, admin, or developer session.
GET
/
api
/
v1
/
developers
/
oauth
/
consent-preview
Preview the consent screen for a scope request
curl --request GET \
--url https://api.orbit.devotel.io/api/v1/developers/oauth/consent-preview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.orbit.devotel.io/api/v1/developers/oauth/consent-preview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orbit.devotel.io/api/v1/developers/oauth/consent-preview', 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.orbit.devotel.io/api/v1/developers/oauth/consent-preview",
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: Bearer <token>"
],
]);
$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.orbit.devotel.io/api/v1/developers/oauth/consent-preview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.orbit.devotel.io/api/v1/developers/oauth/consent-preview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/developers/oauth/consent-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"requested": [
"messages:read",
"contacts:write",
"admin"
],
"granted": [
"messages:read",
"contacts:write"
],
"rejected": [
"admin"
],
"consent": [
{
"scope": "messages:read",
"label": "Read messages",
"consent": "View your messages and their delivery status.",
"sensitive": false
},
{
"scope": "contacts:write",
"label": "Manage contacts",
"consent": "Create and update contacts in your workspace.",
"sensitive": false
}
]
},
"meta": {
"request_id": "req_9c8f2a1b",
"timestamp": "2026-08-08T12:00:00.000Z"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Query Parameters
Space-delimited scope request, e.g. messages:read contacts:write. URL-encode the spaces (%20).
⌘I