Get hierarchy schema for the active Environment
/api/v1/hierarchy-schemaAuthentication
- Bearer Token
AuthorizationJWT access token
- API Key
X-API-KeyAPI key for management-tier access
Code samples
curl -X GET "https://api.canopy.dev/api/v1/hierarchy-schema" \ -H "X-API-Key: $CANOPY_API_KEY"
const response = await fetch("https://api.canopy.dev/api/v1/hierarchy-schema", {
method: "GET",
headers: {
"X-API-Key": "$CANOPY_API_KEY"
},
});
const data = await response.json();import requests
response = requests.get(
"https://api.canopy.dev/api/v1/hierarchy-schema",
headers={
"X-API-Key": "$CANOPY_API_KEY"
},
)
data = response.json()package main
import (
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.canopy.dev/api/v1/hierarchy-schema", nil)
req.Header.Set("X-API-Key", "$CANOPY_API_KEY")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
}Responses
200 Hierarchy schema returned
{
"node_types": [
"string"
],
"allowed_children": {},
"max_depth": 0,
"root_node_type": "string"
}application/json
node_types *string[]allowed_children *any objectmax_depth *numberroot_node_typestring
401 Invalid or expired token
403 This token is not authorized for this endpoint (wrong principal type — e.g., admin token on identity-only endpoint, or vice versa)