Buscar Playbook
GET/external/v1/playbooks/:idBusca um playbook com suas etapas em ordem: o que cada etapa cria, qual o prazo e quem a recebe.
Autenticação
Requer permissão playbooks:read. O playbook precisa estar visível para o usuário que criou a chave (veja Listar Playbooks); caso contrário, a resposta é 404.
Parâmetros de Caminho
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Identificador do playbook (UUID) |
Requisição
bash
curl --request GET \
--url "https://app.getraze.com/external/v1/playbooks/9d2c7a1e-4b3f-4e8a-a6d5-1c0b9f8e7d62" \
--header "X-API-Key: YOUR_API_KEY"javascript
const axios = require('axios');
const playbookId = '9d2c7a1e-4b3f-4e8a-a6d5-1c0b9f8e7d62';
const response = await axios.get(
`https://app.getraze.com/external/v1/playbooks/${playbookId}`,
{ headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);
console.log(response.data);python
import requests
playbook_id = '9d2c7a1e-4b3f-4e8a-a6d5-1c0b9f8e7d62'
response = requests.get(
f'https://app.getraze.com/external/v1/playbooks/{playbook_id}',
headers={'X-API-Key': 'YOUR_API_KEY'}
)
print(response.json())Resposta
Os campos de Listar Playbooks, mais steps.
json
{
"success": true,
"data": {
"id": "9d2c7a1e-4b3f-4e8a-a6d5-1c0b9f8e7d62",
"name": "Onboarding",
"visibility": "team",
"is_active": true,
"steps_count": 3,
"duration_hours": 50,
"steps": [
{
"id": "b7c6d5e4-f3a2-4b1c-9d8e-7f6a5b4c3d2e",
"position": 1,
"title": "Ligação de boas-vindas",
"description": null,
"task_type": "call",
"priority": "high",
"due": { "hours": 2, "from": "run_start", "offset_hours_from_start": 2 },
"assignee_mode": "owner",
"assignees": [],
"labels": [],
"subtasks_count": 0,
"size": null,
"estimate_hours": null
},
{
"id": "c8d7e6f5-a4b3-4c2d-8e9f-0a1b2c3d4e5f",
"position": 2,
"title": "Enviar o kit de onboarding",
"task_type": "email",
"priority": "medium",
"due": { "hours": 24, "from": "previous_step", "offset_hours_from_start": 26 },
"assignee_mode": "users",
"assignees": [{ "id": "2d19889d-6ff9-4782-8165-32e56bb593c0", "name": "Maria Silva" }],
"labels": [{ "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "name": "Onboarding", "color": "#22c55e" }],
"subtasks_count": 3
}
]
}
}Campos das Etapas
| Campo | Tipo | Descrição |
|---|---|---|
position | integer | Ordem da etapa (começando em 1) |
title / description | string | Copiados para a tarefa que a etapa cria |
task_type / priority | string | Copiados para a tarefa |
due.hours / due.from | integer / string | O prazo da etapa é hours depois do início da execução (run_start) ou depois do prazo da etapa anterior (previous_step) |
due.offset_hours_from_start | integer | A posição resultante na cadeia, em horas a partir do início da execução |
assignee_mode | string | Quem recebe a tarefa: users (as pessoas em assignees), owner (o responsável da oportunidade ou, quando não há responsável, quem atende a conversa) ou none |
assignees | array | Pessoas de uma etapa users |
labels | array | Etiquetas de tarefa copiadas para a tarefa |
subtasks_count | integer | Itens de checklist copiados para a tarefa |
size / estimate_hours | string / number | Copiados para a tarefa (nullable) |
O responsável do negócio é lido uma vez
Nas etapas owner, o responsável é lido quando a execução começa. Trocar o responsável da oportunidade depois não move as tarefas que já existem.