Skip to content

Listar Execuções de Playbook ​

GET /external/v1/playbook-runs

Retorna as execuções de playbooks, das mais recentes para as mais antigas. Uma execução é um playbook aplicado a um contato, a uma oportunidade ou a um título interno; as etapas dela são tarefas. Use este endpoint para acompanhar o progresso e identificar execuções atrasadas no cronograma.

Autenticação ​

Requer permissão playbooks:read. Todas as execuções da conta são listadas, seja quem for que as iniciou (como no app).

Parâmetros de Consulta ​

ParâmetroTipoPadrãoDescrição
pageinteger1Número da página
limitinteger50Itens por página (1-100)
playbook_idstring-Apenas execuções deste playbook
statusstring-in_progress, completed ou cancelled
overdueboolean-true = apenas execuções em andamento com pelo menos uma etapa atrasada
contact_idstring-Apenas execuções deste contato
opportunity_idstring-Apenas execuções desta oportunidade
searchstring-Correspondência parcial no nome do contato, empresa, nome do playbook ou título da execução
started_after / started_beforestring (ISO 8601)-Intervalo da data de início

Requisição ​

bash
curl --request GET \
  --url "https://app.getraze.com/external/v1/playbook-runs?status=in_progress&overdue=true" \
  --header "X-API-Key: YOUR_API_KEY"
javascript
const axios = require('axios');

const response = await axios.get('https://app.getraze.com/external/v1/playbook-runs', {
  headers: { 'X-API-Key': 'YOUR_API_KEY' },
  params: { status: 'in_progress', overdue: true }
});

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

response = requests.get(
    'https://app.getraze.com/external/v1/playbook-runs',
    headers={'X-API-Key': 'YOUR_API_KEY'},
    params={'status': 'in_progress', 'overdue': 'true'}
)

print(response.json())

Resposta ​

json
{
  "success": true,
  "data": [
    {
      "id": "3ef8c1c3-c081-4187-a6aa-657fbf1a813b",
      "playbook": { "id": "9d2c7a1e-4b3f-4e8a-a6d5-1c0b9f8e7d62", "name": "Onboarding" },
      "title": null,
      "status": "in_progress",
      "is_overdue": true,
      "context": {
        "type": "contact",
        "name": "John Doe",
        "contact": { "id": "c2f9d1a4-5b7e-4c1a-9e0f-3a8b6d2c4e71", "name": "John Doe", "company": "Acme Inc" },
        "opportunity": null,
        "conversation_id": null
      },
      "progress": { "steps_done": 2, "steps_total": 5, "overdue_steps": 1 },
      "current_step": {
        "task_id": "a8e9f0b1-c2d3-4e5f-8a9b-0c1d2e3f4a5b",
        "position": 3,
        "title": "Reunião de kick-off",
        "due_date": "2026-10-17T13:00:00.000Z"
      },
      "started_by": { "id": "2d19889d-6ff9-4782-8165-32e56bb593c0", "name": "Maria Silva" },
      "started_at": "2026-10-13T12:00:00.000Z",
      "completed_at": null,
      "cancelled_at": null,
      "cancelled_reason": null
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 2,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  }
}

Campos da Resposta ​

CampoTipoDescrição
idstringIdentificador da execução
playbookobjectPlaybook de que a execução veio. O nome é o que ele tinha quando a execução começou
titlestringTítulo da execução (execuções internas)
statusstringin_progress, completed (todas as etapas concluídas) ou cancelled
is_overduebooleanEm andamento com pelo menos uma etapa atrasada
context.typestringcontact, internal ou client (uma execução sobre uma conta de cliente, criada no app)
context.namestringO que o app mostra como nome da execução: cliente, contato ou título
context.contact / context.opportunity / context.conversation_idobject / stringDe que trata a execução (nullable)
progressobjectEtapas concluídas, total de etapas e etapas atrasadas
current_stepobjectPrimeira etapa ainda não concluída; null quando a execução não está em andamento
started_byobjectQuem iniciou a execução
started_at / completed_at / cancelled_atstringTimestamps em UTC (nullable)
cancelled_reasonstringMotivo informado ao cancelar (nullable)

GetRaze - AI-Powered Lead Generation