Schemas

List fields

Paginated list of fields from the field registry, filterable by search, tier, or cluster.

get/v1/fields

Request

Base URL: https://api.talonic.com
URL: https://api.talonic.com/v1/fields
Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of items to return (1–100).

cursorstring

Opaque pagination cursor from a previous response's pagination.next_cursor.

order'asc' | 'desc'

Sort order by creation date.

searchstring

Case-insensitive search on canonical_name or display_name.

tierinteger

Filter by tier.

cluster_idstring uuid

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Filter by cluster.

maturity'core' | 'proven' | 'candidate'

Filter by the named maturity level (core = tier 1, proven = tier 2, candidate = tier 3). Takes precedence over tier. Unknown values 400 (invalid_maturity).

include_supersededboolean

Superseded rows (merged into a survivor; superseded_by set) are hidden by default so a cached vocabulary never carries two ids for one concept. true includes them.

admission_state'canonical' | 'provisional' | 'all'

Canonical read plane. Defaults to proven concepts only; provisional shows the recurrence-gated pool, all disables the filter.

Response

Paginated list of fields.

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "pagination": {
    "total": 142,
    "limit": 20,
    "has_more": true,
    "next_cursor": "ZDFhMmIzYzR8MjAyNi0wNC0wM1QxMjowMDowMC4wMDBa"
  }
}

Changes

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