pipelines.attendant_types_get

Ver tipos de atendente e atendentes de um pipeline. Tipos de atendente usados no pipeline, com a comissão de cada um (commissionType percentage em pontos-base, 100 = 1%, ou fixed em centavos por oportunidade ganha), e os atendentes do pipeline com o peso do rodízio (0 a 10). Sem a migration de atendentes, vazio.

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

Entrada

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

Exemplo

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

CLI:

node cli/atomiks.mjs pipelines.attendant_types_get --json '{"pipelineId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta pipelines_attendant_types_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": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "attendantTypeId": {
            "type": "string"
          },
          "attendantTypeName": {
            "type": "string"
          },
          "attendantTypeEmoji": {
            "type": [
              "string",
              "null"
            ]
          },
          "attendantTypeColor": {
            "type": [
              "string",
              "null"
            ]
          },
          "commissionType": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "percentage",
                  "fixed"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "commissionPercentBp": {
            "type": [
              "number",
              "null"
            ]
          },
          "commissionFixedCents": {
            "type": [
              "number",
              "null"
            ]
          }
        },
        "required": [
          "attendantTypeId",
          "attendantTypeName",
          "attendantTypeEmoji",
          "attendantTypeColor",
          "commissionType",
          "commissionPercentBp",
          "commissionFixedCents"
        ],
        "additionalProperties": false
      }
    },
    "attendants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "attendantId": {
            "type": "string"
          },
          "weight": {
            "type": "number"
          }
        },
        "required": [
          "attendantId",
          "weight"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items",
    "attendants"
  ],
  "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).