crm.fields_list

Listar campos personalizados da conta. Definições dos campos personalizados, em ordem. includeArchived: true traz também os arquivados. type é o armazenamento (text, number, date, select com options, boolean, file) e fieldType o tipo da tela (também textarea, currency, percentage, multi_select, radio, link, rating, image).

• Endpoint: POST https://app.atomiks.com.br/api/v1/crm.fields_list (corpo JSON)
• Quem pode chamar: membro da conta
• Escopo da chave: crm:read
• Grava dados: não
• Pela chave de API: sim
• Ferramenta MCP: crm_fields_list
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId crm.fields_list)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "includeArchived": {
      "type": "boolean"
    }
  }
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/crm.fields_list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

node cli/atomiks.mjs crm.fields_list --json '{}'

MCP: ferramenta crm_fields_list com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "text",
              "number",
              "date",
              "select",
              "boolean",
              "file"
            ]
          },
          "fieldType": {
            "type": "string",
            "enum": [
              "text",
              "textarea",
              "number",
              "currency",
              "percentage",
              "date",
              "select",
              "multi_select",
              "radio",
              "link",
              "rating",
              "boolean",
              "file",
              "image"
            ]
          },
          "options": {
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "position": {
            "type": "number"
          },
          "archived": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "key",
          "label",
          "type",
          "fieldType",
          "options",
          "position",
          "archived"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).