Skip to content

Listar Playbooks ​

GET /external/v1/playbooks

Retorna os playbooks da conta. Um playbook é uma sequência reutilizável de etapas ("ligar em 2 horas, enviar a proposta no dia seguinte, fazer follow-up 2 dias depois"). Cada vez que você o inicia em um contato, oportunidade ou título interno, cria uma execução de playbook, e cada etapa vira uma tarefa de verdade, com prazo próprio.

Autenticação ​

Requer permissão playbooks:read.

O que a chave enxerga

Uma chave enxerga os mesmos playbooks que o usuário que criou a chave enxerga no app. Administradores veem todos os playbooks da conta. Os demais usuários veem os próprios playbooks, mais os compartilhados com a equipe (visibility: team).

Parâmetros de Consulta ​

ParâmetroTipoPadrãoDescrição
searchstring-Correspondência parcial no nome ou no atalho
include_inactivebooleanfalseRetorna também os playbooks inativos

Esta lista não é paginada.

Requisição ​

bash
curl --request GET \
  --url "https://app.getraze.com/external/v1/playbooks" \
  --header "X-API-Key: YOUR_API_KEY"
javascript
const axios = require('axios');

const response = await axios.get('https://app.getraze.com/external/v1/playbooks', {
  headers: { 'X-API-Key': 'YOUR_API_KEY' }
});

console.log(response.data);
python
import requests

response = requests.get(
    'https://app.getraze.com/external/v1/playbooks',
    headers={'X-API-Key': 'YOUR_API_KEY'}
)

print(response.json())

Resposta ​

json
{
  "success": true,
  "data": [
    {
      "id": "9d2c7a1e-4b3f-4e8a-a6d5-1c0b9f8e7d62",
      "name": "Onboarding",
      "description": "Primeira semana de um novo cliente",
      "shortcut": "onboarding",
      "visibility": "team",
      "is_active": true,
      "steps_count": 5,
      "duration_hours": 120,
      "uses_deal_owner": true,
      "runs": { "active": 8, "overdue": 2, "completed": 31, "total": 41 },
      "created_by": { "id": "2d19889d-6ff9-4782-8165-32e56bb593c0", "name": "Maria Silva" },
      "created_at": "2026-08-02T12:00:00.000Z",
      "updated_at": "2026-10-01T18:30:00.000Z"
    }
  ]
}

Campos da Resposta ​

CampoTipoDescrição
idstringIdentificador do playbook
name / descriptionstringNome e descrição
shortcutstringAtalho usado para iniciá-lo pelo chat (/onboarding)
visibilitystringteam (todos da conta) ou private (só o autor e os administradores)
is_activebooleanPlaybooks inativos não podem ser iniciados
steps_countintegerNúmero de etapas
duration_hoursintegerHoras entre o início de uma execução e o prazo da última etapa
uses_deal_ownerbooleanPelo menos uma etapa é atribuída ao responsável do negócio. Uma execução sem contato nem oportunidade deixa essas etapas sem responsável
runsobjectContagem de execuções: em andamento, em andamento com etapa atrasada, concluídas, total
created_byobjectAutor
created_at / updated_atstringTimestamps em UTC

GetRaze - AI-Powered Lead Generation