Schemas

Resolve a field name to the live concept

Stable-identity entry point for a consumer that holds a field NAME rather than an id. Lookup order, first hit wins — indexed arms first, then two case-insensitive sequential-scan fallbacks: exact canonical_name → the registry match_key fold (separator / case / accent / plural insensitive, the same field_match_key() the resolver binds with) → a merge alias (field_registry_aliases) → exact synonyms[] containment (names folded in by merges and cleanup) → case-insensitive canonical name → case-insensitive synonym. The hit's redirect chain is then followed to the survivor unless follow_redirects=false, and every hop is reported in redirected_from so a cache can rewrite its keys.

get/v1/fields/resolve

Request

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

Query parameters

namestring required

The field name to resolve, e.g. Invoice No.

follow_redirectsboolean

Walk superseded_by to the live survivor (default true).

Response

The resolved concept.

namestring required
matched_by'canonical_name' | 'synonym' | 'alias' | 'match_key' required
redirected_fromstring[] required

Ids walked through superseded_by, oldest first (empty when the hit was live).

Example response

{
  "field": {
    "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"
  }
}

Changes

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