Schemas

Get a field

Returns the field registry row plus up to 20 most recent occurrences.

A superseded row (merged into a survivor) is returned as-is with superseded_by set, so a stored id never 404s after curation. Pass follow_redirects=true to receive the survivor instead; the hops walked are listed in redirected_from.

get/v1/fields/{id}

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/fields/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Resource UUID.

Query parameters

follow_redirectsboolean

Walk superseded_by to the live survivor and return that row.

Response

Field detail.

idstring uuid required
canonical_namestring required
maturity'core' | 'proven' | 'candidate' required

Named maturity level — the contract a consumer caching the vocabulary can rely on (tier is the frozen numeric twin: core = 1, proven = 2, candidate = 3).

  • core: universal, fully trusted; safe to bind schemas, dashboards and downstream models to. Demotion is hysteresis-guarded and always emits field.demoted.
  • proven: recurring and useful; stable id, name may still be groomed (field.renamed / field.merged announce it).
  • candidate: newly discovered; may be merged, renamed or expire with no notice beyond the event feed. Do not hard-code.
admission_state'canonical' | 'provisional'
descriptionstring nullable

Curated semantic description of the concept.

synonymsstring[]

Names folded onto this concept by merges and cleanup; all resolve via GET /v1/fields/resolve.

display_namestring required

Human-readable label, always present. A stored display name wins; otherwise it is derived from canonical_name, e.g. invoice_number → Invoice Number.

data_typestring required
tierinteger required
cluster_namestring nullable
occurrence_countinteger required
master_instructionstring nullable
created_atstring date-time required
updated_atstring date-time
redirected_fromstring[]

Ids walked when follow_redirects=true (oldest first); empty otherwise.

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "canonical_name": "invoice_number",
  "display_name": "Invoice Number",
  "data_type": "string",
  "created_at": "2026-04-25T14:30:00.000Z",
  "updated_at": "2026-04-25T14:30:00.000Z",
  "recent_occurrences": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "document_id": "f0e1d2c3-b4a5-9687-8765-432109876543",
      "created_at": "2026-04-25T14:30:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.