Get Organization Onboarding Status
curl --request GET \
--url https://use.hoop.dev/api/orgs/onboardingimport requests
url = "https://use.hoop.dev/api/orgs/onboarding"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://use.hoop.dev/api/orgs/onboarding', 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://use.hoop.dev/api/orgs/onboarding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://use.hoop.dev/api/orgs/onboarding"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://use.hoop.dev/api/orgs/onboarding")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/orgs/onboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"checks": {
"agent_deployed": true,
"ai_analyzer_enabled": true,
"data_masking_explored": true,
"groups_created": true,
"guardrails_explored": true,
"people_assigned": true,
"protection_level_set": true,
"resource_created": true,
"session_ran": true
},
"completed": true,
"exec_connection_name": "pgdemo",
"first_connection_name": "pgdemo"
}{
"message": "the error description"
}Server Management
Get Organization Onboarding Status
Get the setup checklist state for the caller’s organization. Each step latches the first time it is satisfied, so a check never reverts. Once every check passes, show_setup_checklist on /userinfo turns false — the signal to stop calling this endpoint.
GET
/
orgs
/
onboarding
Get Organization Onboarding Status
curl --request GET \
--url https://use.hoop.dev/api/orgs/onboardingimport requests
url = "https://use.hoop.dev/api/orgs/onboarding"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://use.hoop.dev/api/orgs/onboarding', 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://use.hoop.dev/api/orgs/onboarding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://use.hoop.dev/api/orgs/onboarding"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://use.hoop.dev/api/orgs/onboarding")
.asString();require 'uri'
require 'net/http'
url = URI("https://use.hoop.dev/api/orgs/onboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"checks": {
"agent_deployed": true,
"ai_analyzer_enabled": true,
"data_masking_explored": true,
"groups_created": true,
"guardrails_explored": true,
"people_assigned": true,
"protection_level_set": true,
"resource_created": true,
"session_ran": true
},
"completed": true,
"exec_connection_name": "pgdemo",
"first_connection_name": "pgdemo"
}{
"message": "the error description"
}Response
OK
The live state of each checklist item
Show child attributes
Show child attributes
Whether onboarding is finished. Terminal: stays true even if an individual check later regresses
First web-terminal capable connection, for the "Run your first session" shortcut; null when the organization has none
Example:
"pgdemo"
First connection of any kind, the native-access fallback for the same shortcut; null when the organization has no connections
Example:
"pgdemo"
Was this page helpful?