Get organization
curl --request GET \
--url https://cp.xenovia.io/api/v1/orgs/{org_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://cp.xenovia.io/api/v1/orgs/{org_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cp.xenovia.io/api/v1/orgs/{org_id}', 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://cp.xenovia.io/api/v1/orgs/{org_id}",
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://cp.xenovia.io/api/v1/orgs/{org_id}"
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://cp.xenovia.io/api/v1/orgs/{org_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cp.xenovia.io/api/v1/orgs/{org_id}")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"slug": "<string>",
"clerk_org_id": "<string>",
"plan": "free",
"status": "pending",
"onboarding_state": {
"status": "not_started",
"completed_steps": [
"provider"
],
"proxy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"started_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"skipped_at": "2023-11-07T05:31:56Z",
"skipped_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"completed_at": "2023-11-07T05:31:56Z",
"completed_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"viewer_product_tour_eligible": true,
"viewer_product_tour_state": {
"version": 1,
"status": "not_started",
"current_step": "dashboard",
"visited_steps": [
"dashboard"
],
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"dismissed_at": "2023-11-07T05:31:56Z"
},
"metronome_customer_id": "<string>",
"entitlements": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Organization
Get organization
Auth: signed-in user only (any active member). Organization API keys are rejected with 403.
org_id is the Clerk organization id (org_…). Includes onboarding state and entitlements.
GET
/
api
/
v1
/
orgs
/
{org_id}
Get organization
curl --request GET \
--url https://cp.xenovia.io/api/v1/orgs/{org_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://cp.xenovia.io/api/v1/orgs/{org_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cp.xenovia.io/api/v1/orgs/{org_id}', 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://cp.xenovia.io/api/v1/orgs/{org_id}",
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://cp.xenovia.io/api/v1/orgs/{org_id}"
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://cp.xenovia.io/api/v1/orgs/{org_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cp.xenovia.io/api/v1/orgs/{org_id}")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"slug": "<string>",
"clerk_org_id": "<string>",
"plan": "free",
"status": "pending",
"onboarding_state": {
"status": "not_started",
"completed_steps": [
"provider"
],
"proxy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"started_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"skipped_at": "2023-11-07T05:31:56Z",
"skipped_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"completed_at": "2023-11-07T05:31:56Z",
"completed_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"viewer_product_tour_eligible": true,
"viewer_product_tour_state": {
"version": 1,
"status": "not_started",
"current_step": "dashboard",
"visited_steps": [
"dashboard"
],
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"dismissed_at": "2023-11-07T05:31:56Z"
},
"metronome_customer_id": "<string>",
"entitlements": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer token: an organization API key (ak_…) created under Settings → API Keys, or a dashboard user session token. Proxy keys (xe_…) are not accepted here. Endpoints marked as user-only in their description reject organization keys with 403.
Path Parameters
Response
Successful Response
Available options:
free, pro, enterprise Available options:
pending, active, suspended, deleted Show child attributes
Show child attributes
Show child attributes
Show child attributes