AtomiksAPI
Ver .md

companies.facets

Opções dos filtros de empresas. Valores que a conta já usa em UF, cidade e setor (para os filtros da lista). cnaes, sizeEstimates e statuses vêm do Econodata e saem vazios.

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

Entrada

Sem campos: envie {}.

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

Exemplo

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

CLI:

node cli/atomiks.mjs companies.facets --json '{}'

MCP: ferramenta companies_facets com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "states": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "cities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sectors": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "cnaes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "code",
          "description"
        ],
        "additionalProperties": false
      }
    },
    "sizeEstimates": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statuses": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "states",
    "cities",
    "sectors",
    "cnaes",
    "sizeEstimates",
    "statuses"
  ],
  "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).