Book a demo

list_data_fields

List the data field classes

read collection tenant-private since 2026-10-01

Lists the four field classes a role template's data policy is written in (commercial, financial, personal, operational), each with examples, the capability fields and database columns it covers, and how many. Operational is everything else and is counted, not listed.

Contract

shape
collection
authority
read
evidence
none
subscription
false
permission
any one of: role.read (carried by the caller's role template in the org `org_id`); a deactivated caller is refused first
idempotency
safe
emits
none
MCP tool
list_data_fields
REST
POST https://api.containertradehq.com/v1/cap/list_data_fields

Idempotency: a read: calling again changes nothing

Inputs

nametyperequiredvalidation
org_idorg_idrequiredtradehq-org-id; 1 to 20 characters
The org whose role templates are being read.

Paginated: next next_after · page_max 4 · walk_max 4 · ceiling declared

Response

  • items · object[]
  • next_after · stringnull · Pass as `after` for the next page; null on the last one.
Full JSON Schema 
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "class": {
            "type": "string",
            "enum": [
              "commercial",
              "financial",
              "personal",
              "operational"
            ],
            "description": "commercial, financial, personal or operational.",
            "x-data-class": "operational"
          },
          "title": {
            "type": "string",
            "description": "Its name.",
            "x-data-class": "operational"
          },
          "examples": {
            "type": "string",
            "description": "What it covers, in plain words.",
            "x-data-class": "operational"
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The capability fields of this class, as capability.field; empty for operational.",
            "x-data-class": "operational"
          },
          "columns": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The database columns of this class the GraphQL surface serves, as schema.relation.column; empty for operational.",
            "x-data-class": "operational"
          },
          "field_count": {
            "type": "integer",
            "minimum": 0,
            "description": "How many capability fields are of this class.",
            "x-data-class": "operational"
          },
          "column_count": {
            "type": "integer",
            "minimum": 0,
            "description": "How many database columns are of this class, served on GraphQL or not.",
            "x-data-class": "operational"
          }
        },
        "required": [
          "class",
          "title",
          "examples",
          "fields",
          "columns",
          "field_count",
          "column_count"
        ],
        "additionalProperties": false
      },
      "maxItems": 4
    },
    "next_after": {
      "type": [
        "string",
        "null"
      ],
      "description": "Pass as `after` for the next page; null on the last one."
    }
  },
  "required": [
    "items",
    "next_after"
  ],
  "additionalProperties": false
}

Refusals

The platform refusals apply to every call: version, authentication, authority, validation and rate limits, each in the same envelope.

Surfaces

DesktopF
MobileF
APIF
MCPF
VoiceD4
PushN
OneBoxN
OutboundN
  • Voice: degraded: visualization
  • Push: emits nothing
  • OneBox: no document originates the class catalogue
  • Outbound: crosses to no counterparty

Events

None emitted.

Related

None.