playbooks.list

Listar playbooks. Playbooks da conta, do mais recém-editado ao mais antigo, com escopos (meeting, livechat; whatsapp e flows ainda não estão disponíveis), quantos pipelines usam (pipelinesCount) e quantas etapas e perguntas têm. scope filtra por escopo (o seletor do cockpit do lead usa livechat). Sem a migration, a lista vem vazia.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": [
        "meeting",
        "whatsapp",
        "livechat",
        "flows"
      ]
    }
  }
}

Exemplo

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

CLI:

node cli/atomiks.mjs playbooks.list --json '{"scope":"livechat"}'

MCP: ferramenta playbooks_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"
          },
          "description": {
            "type": "string"
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "meeting",
                "whatsapp",
                "livechat",
                "flows"
              ]
            }
          },
          "pipelinesCount": {
            "type": "number"
          },
          "stagesCount": {
            "type": "number"
          },
          "questionsCount": {
            "type": "number"
          },
          "createdAt": {
            "type": "string"
          },
          "updatedAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "scopes",
          "pipelinesCount",
          "stagesCount",
          "questionsCount",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "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).