attendants.list

Listar atendentes com números. Membros da conta que são atendentes, cada um com tipos, pipelines e números das oportunidades de que é responsável (ganhas, perdidas, receita ganha, comissão, reuniões, conversão), mais os totais do topo da tela (kpis, calculados sobre todos, sem o filtro). search filtra pelo nome. Número sem fonte vem null. Sem a migration de atendentes, tipos e pipelines vêm vazios.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "search": {
      "type": "string",
      "maxLength": 120
    }
  }
}

Exemplo

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

CLI:

node cli/atomiks.mjs attendants.list --json '{}'

MCP: ferramenta attendants_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"
          },
          "name": {
            "type": "string"
          },
          "initials": {
            "type": "string"
          },
          "imageUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "color": {
            "type": [
              "string",
              "null"
            ]
          },
          "role": {
            "type": "string",
            "enum": [
              "admin",
              "user"
            ]
          },
          "createdAt": {
            "type": "string"
          },
          "meetingRoomUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "types": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "emoji": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "color": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "emoji",
                "color"
              ],
              "additionalProperties": false
            }
          },
          "pipelines": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "name"
              ],
              "additionalProperties": false
            }
          },
          "stats": {
            "type": "object",
            "properties": {
              "opportunities": {
                "type": "number"
              },
              "openOpportunities": {
                "type": "number"
              },
              "wonOpportunities": {
                "type": "number"
              },
              "lostOpportunities": {
                "type": "number"
              },
              "wonValueCents": {
                "type": "number"
              },
              "commissionCents": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "meetingsScheduled": {
                "type": "number"
              },
              "meetingsCompleted": {
                "type": "number"
              },
              "conversion": {
                "type": [
                  "number",
                  "null"
                ]
              }
            },
            "required": [
              "opportunities",
              "openOpportunities",
              "wonOpportunities",
              "lostOpportunities",
              "wonValueCents",
              "commissionCents",
              "meetingsScheduled",
              "meetingsCompleted",
              "conversion"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "id",
          "name",
          "initials",
          "imageUrl",
          "color",
          "role",
          "createdAt",
          "meetingRoomUrl",
          "types",
          "pipelines",
          "stats"
        ],
        "additionalProperties": false
      }
    },
    "kpis": {
      "type": "object",
      "properties": {
        "totalAttendants": {
          "type": "number"
        },
        "withOpportunities": {
          "type": "number"
        },
        "totalRevenueCents": {
          "type": "number"
        },
        "avgRevenuePerAttendantCents": {
          "type": "number"
        },
        "avgConversion": {
          "type": "number"
        },
        "totalOpportunities": {
          "type": "number"
        },
        "avgOpportunitiesPerAttendant": {
          "type": "number"
        }
      },
      "required": [
        "totalAttendants",
        "withOpportunities",
        "totalRevenueCents",
        "avgRevenuePerAttendantCents",
        "avgConversion",
        "totalOpportunities",
        "avgOpportunitiesPerAttendant"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "items",
    "kpis"
  ],
  "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).