read.internal.custom_field_definitions

The tenant’s custom field definitions (product + cart levels). Internal face only.

• Surface: GET /v1/read/internal/custom_field_definitions · MCP tool read.internal.custom_field_definitions
• Auth: ★ Internal read (operator) — a tenant credential is REQUIRED; requires the tenant.settings.read scope. The tenant is resolved from the CALLER’s identity, never from store. Personal fields come back MASKED for an actor without pii.read (the shape is unchanged).

Params (JSON Schema)

{
  "properties": {
    "include_archived": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "enum": [
            "0",
            "1",
            "true",
            "false"
          ],
          "type": "string"
        }
      ]
    },
    "owner_entity": {
      "type": "string"
    },
    "q": {
      "minLength": 1,
      "type": "string"
    },
    "state": {
      "enum": [
        "all",
        "active",
        "archived"
      ],
      "type": "string"
    },
    "with_usage": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "enum": [
            "0",
            "1",
            "true",
            "false"
          ],
          "type": "string"
        }
      ]
    }
  },
  "type": "object"
}

Result (200)

Open (unknown) — this capability does not declare an output schema.

Errors

validation_failed (400) · not_found (404) · unauthorized (401) · forbidden (403)