segmentation.segment_get

Ver um segmento com a contagem de contatos. Um segmento salvo (nome, emoji, filter) e o total de contatos que ele casa agora.

• Endpoint: POST https://app.atomiks.com.br/api/v1/segmentation.segment_get (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_segment_get
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId segmentation.segment_get)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "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)$"
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/segmentation.segment_get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs segmentation.segment_get --json '{"id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta segmentation_segment_get com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "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
}

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).