segmentation.segments_overview

Segmentos com a contagem de contatos. Lista de "Segmentos" (Contatos & Comercial > Segmentação > Filtros): cada segmento salvo com o total de contatos que o filtro casa agora (leadCount, só os contatos que quem pede vê). Do mais recentemente editado ao mais antigo; q filtra pelo nome. Paginação de 10 por padrão.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "q": {
      "type": "string",
      "maxLength": 80
    },
    "page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10000
    },
    "perPage": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  }
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/segmentation.segments_overview \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":1,"perPage":10}'

CLI:

node cli/atomiks.mjs segmentation.segments_overview --json '{"page":1,"perPage":10}'

MCP: ferramenta segmentation_segments_overview 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"
          },
          "name": {
            "type": "string"
          },
          "emoji": {
            "type": [
              "string",
              "null"
            ]
          },
          "filter": {
            "maxItems": 200,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "maxLength": 64
                },
                "order": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 1000
                },
                "field": {
                  "type": "string",
                  "maxLength": 60
                },
                "operator": {
                  "type": "string",
                  "maxLength": 30
                },
                "negation": {
                  "default": false,
                  "type": "boolean"
                },
                "parentId": {
                  "anyOf": [
                    {
                      "type": "string",
                      "maxLength": 64
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "valueString": {
                  "anyOf": [
                    {
                      "type": "string",
                      "maxLength": 4000
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "valueNumber": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "valueDate": {
                  "anyOf": [
                    {
                      "type": "string",
                      "maxLength": 40
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "valueBool": {
                  "type": [
                    "boolean",
                    "null"
                  ]
                },
                "valueUuid": {
                  "anyOf": [
                    {
                      "type": "string",
                      "format": "uuid",
                      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "field",
                "operator",
                "negation"
              ],
              "additionalProperties": false
            }
          },
          "leadCount": {
            "type": "number"
          },
          "refreshedAt": {
            "type": "string"
          },
          "createdAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "emoji",
          "filter",
          "leadCount",
          "refreshedAt",
          "createdAt"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "number"
    },
    "countPages": {
      "type": "number"
    }
  },
  "required": [
    "items",
    "total",
    "countPages"
  ],
  "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).