Skip to main content
GET
Get a registered structure

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer <key>. Each operation lists the scope its key needs: decisions:evaluate (evaluate and read evaluations), decisions:feedback (your app's feedback) or decisions:develop (everything else, including owner feedback and the review queue). An operation listing no scope takes any scoped key. A key with no scope, or without the operation's, gets 403 INSUFFICIENT_SCOPE.

Path Parameters

decision_id
string
required
Pattern: ^[a-z][a-z0-9_.-]{0,127}$
structure_hash
string
required
Pattern: ^sha256:[0-9a-f]{64}$

Response

The registered structure

environment
enum<string>
required

The environment of the key that made the call: production or test. Evaluations, feedback, reviews and suggestions are separate per environment; registered structures are shared.

Available options:
production,
test
decision_id
string
required
Pattern: ^[a-z][a-z0-9_.-]{0,127}$
structure_hash
string
required
Pattern: ^sha256:[0-9a-f]{64}$
question_hashes
object
required

Each question, by name, mapped to its hash (its definition without its name). A question's hash is what feedback about it is stored against.

first_seen_at
string<date-time>
required
created
boolean
required
structure
object
required

The registered structure, in authored key order.