talonic_list_fields
List the workspace's Field Registry — the canonical concepts Talonic has discovered across every ingested document. Each entry carries a stable id, canonical_name, data_type, a named maturity level, synonyms, a curated description, occurrence_count and superseded_by when the row was merged into another concept.
When to use
- You need to know WHAT data exists before querying it.
- You want the exact field id for
talonic_get_fieldortalonic_field_values. - You are choosing between similar concepts and want their maturity and occurrence counts side by side.
When not to use
- To locate a specific document by name — use
talonic_search. - To filter documents by a field value — use
talonic_filter. - When you are unsure which field holds a concept — call
talonic_find_datafirst; it matches by meaning.
Parameters
| Parameter | Type | Description |
|---|---|---|
| search | string | Case-insensitive contains match on canonical_name / display_name. |
| maturity | string | `core`, `proven` or `candidate`. Prefer `core`/`proven` for anything you build on. |
| include_superseded | boolean | Include rows merged into a survivor (they carry `superseded_by`). Default false. |
| limit | number | Page size (default 20, max 100). |
| cursor | string | Opaque cursor from `pagination.next_cursor`. |
Response shape
Fields
| Parameter | Type | Description |
|---|---|---|
| data[].id | string | Stable field UUID. |
| data[].canonical_name | string | Normalized concept name. |
| data[].maturity | string | `core` (fully trusted), `proven` (recurring, stable id) or `candidate` (new; may still be merged or renamed). |
| data[].synonyms | string[] | Names folded onto the concept by merges and cleanup. |
| data[].superseded_by | object|null | Set when the row was merged into a survivor; follow `superseded_by.id`. |
| pagination | object | `total`, `limit`, `has_more`, `next_cursor`. |
Tool input
{ "search": "invoice", "maturity": "proven", "limit": 5 }Tool response
{
"data": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"canonical_name": "invoice_number",
"display_name": "Invoice Number",
"data_type": "string",
"maturity": "proven",
"tier": 2,
"synonyms": ["inv_no", "invoice no"],
"description": "The supplier's invoice identifier",
"occurrence_count": 412,
"superseded_by": null,
"links": { "self": "/v1/fields/a1b2…", "card": "/v1/fields/a1b2…/card", "values": "/v1/fields/a1b2…/values" }
}
],
"pagination": { "total": 1, "limit": 5, "has_more": false, "next_cursor": null }
}Frequently asked questions
What does maturity mean and which level should I build on?+
`core` (tier 1) is universal and fully trusted; `proven` (tier 2) recurs and has a stable id; `candidate` (tier 3) is newly discovered and may still be merged or renamed. Build on `core` or `proven`; treat `candidate` as a hint.