Listar Execuções de Playbook
GET/external/v1/playbook-runsRetorna 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âmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
page | integer | 1 | Número da página |
limit | integer | 50 | Itens por página (1-100) |
playbook_id | string | - | Apenas execuções deste playbook |
status | string | - | in_progress, completed ou cancelled |
overdue | boolean | - | true = apenas execuções em andamento com pelo menos uma etapa atrasada |
contact_id | string | - | Apenas execuções deste contato |
opportunity_id | string | - | Apenas execuções desta oportunidade |
search | string | - | Correspondência parcial no nome do contato, empresa, nome do playbook ou título da execução |
started_after / started_before | string (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
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador da execução |
playbook | object | Playbook de que a execução veio. O nome é o que ele tinha quando a execução começou |
title | string | Título da execução (execuções internas) |
status | string | in_progress, completed (todas as etapas concluídas) ou cancelled |
is_overdue | boolean | Em andamento com pelo menos uma etapa atrasada |
context.type | string | contact, internal ou client (uma execução sobre uma conta de cliente, criada no app) |
context.name | string | O que o app mostra como nome da execução: cliente, contato ou título |
context.contact / context.opportunity / context.conversation_id | object / string | De que trata a execução (nullable) |
progress | object | Etapas concluídas, total de etapas e etapas atrasadas |
current_step | object | Primeira etapa ainda não concluída; null quando a execução não está em andamento |
started_by | object | Quem iniciou a execução |
started_at / completed_at / cancelled_at | string | Timestamps em UTC (nullable) |
cancelled_reason | string | Motivo informado ao cancelar (nullable) |