Skip to main content
GET
Get a state

Authorizations

x-api-key
string
header
required

Path Parameters

name
string
required

Response

Success.

data
ServedStateView · object
required

The full served declaration read of get_state: the base schema and the composed effective_schema (both open JSON-Schema objects), the subject_kinds the state serves and its default_subject_kind, an optional retention_days (null to keep records forever), the state's attachments, the absolute write-regime rules regimes (each {path, regime}), and updated_at (the ISO timestamp of the last write, null before any). The Python attribute for the wire schema key is suffixed to avoid shadowing a BaseModel member; the wire key stays schema via the alias.