Skip to main content
GET
Get a store record

Authorizations

X-API-Key
string
header
required

Path Parameters

store
string
required
key
string
required

Query Parameters

include
enum<string>[]

Optional extra sections on a record read.

layers adds each source's own assertions and provenance beside the resolved view. An out-of-enum value is rejected 422.

Available options:
layers

Response

Successful Response

One record of a store: its resolved view, and optionally its layers.

resolved is the single view computed from the record's layers by your precedence. Request include=layers to also see each source's own assertions and provenance.

key
string
required

The record's key, in the store's canonical key format.

resolved
Resolved · object
required

The resolved view — one value per field, taken from the highest-precedence source asserting it. A field no source asserts is absent rather than null.

resolved_config_version
integer
required

Which precedence version produced this resolved view. A value behind the store's current config_version means the view is awaiting recompute.

created_at
string<date-time>
required

When the record was first written by any source.

updated_at
string<date-time>
required

When any source last wrote to the record.

layers
Layers · object | null

Each source's own assertions, keyed by source name. Present only when include=layers was requested.

lifecycle
StoreLifecycleResponse · object | null

Where the number is in its life. Null until a lifecycle decision has been made about it.

reputation
Reputation · object

Carrier observations about the number, keyed by carrier, with * for an observation not attributed to one. An empty map means no observations — it does not mean the number is clean.

health
StoreHealthResponse · object | null

The number's health bands. Null means nothing has been measured yet. It is not a zero and it is not a band; read it as unmeasured.

census
StoreCensusResponse · object | null

What the last inventory check said. Null until a check has seen the number at all.