Digitalk Developers
  1. Workspaces & Workflows
Raiz
  • Raiz
  • CRM
    • CRM — Overview
    • Genérico (data)
      • CRM - Genérico
      • Listar/filtrar registros (qualquer tabela do CRM)
      • Criar/atualizar registros (qualquer tabela do CRM)
      • Hard-delete (não permitido para tabelas company)
    • Empresas Relacionadas
      • CRM - Empresas relacionadas
      • Tipos de relacionamento disponíveis
      • Listar relacionamentos de uma empresa (ambas as direções)
      • Criar relacionamento entre duas empresas
      • Alterar o tipo do relacionamento
      • Inativar relacionamento (reversível)
      • Excluir relacionamento (hard-delete)
    • Ticket ↔ Empresa
      • CRM - Ticket <-> Empresa
      • Empresas elegíveis para o ticket
      • Vincular / trocar a empresa do ticket
    • Templates
      • CRM - Templates
      • Listar templates do tenant (apenas IDs, sem fields)
      • Detalhe completo do template (com fields)
      • Pesquisa formatada por scope (CRMSearchResult)
  • Workflow
    • Workflow - Overview
    • Tickets
      • Workflow - Tickets
      • Detalhe completo do ticket (mensagens, SLA, fases, customer, empresa, business)
      • Criar ticket (básico, com integração CRM opcional)
      • Criar ticket com auto-vínculo / criação de customer via contato
      • Movimentar ticket entre fases (ou finalizar)
      • Atualizar dados do ticket (nome, descrição)
      • Vincular cliente CRM a um ticket existente
      • Adicionar nota ou mensagem ao ticket
    • Workspaces & Workflows
      • Workflow - Workspaces & Workflows
      • Listar workspaces e workflows acessíveis ao usuário
        GET
      • Listar fases de um workflow
        GET
      • Listar tickets de uma ou mais fases (paginado)
        GET
  1. Workspaces & Workflows

Listar fases de um workflow

GET
/api/v2/workflow-v2/workflows/{workflowId}/phases
Última modificação:2026-05-28 20:05:32
Retorna as phases de um workflow específico. Use pra:
Saber qual id_phase usar em POST /ticket (criação).
Identificar a fase de finalização (finisher: true) pra usar em POST /ticket/finish.
Distinguir fases finalizadoras de sucesso vs insucesso via statusId.

statusId#

idSignificado
1Em andamento
2Finalizadora de insucesso
3Finalizadora de sucesso

finisher#

Flag booleana — fase com finisher: true finaliza o ticket automaticamente
ao recebê-lo (e fecha protocolos associados).

Requisição

Parâmetros de Caminho

Parâmetros Header

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v2/workflow-v2/workflows//phases' \
--header 'api-key: {{api-key}}'

Respostas

🟢200OK
application/json
Lista de phases ordenadas por orderColumn. Quando o workflowId não existe ou não tem fases, retorna array vazio ([]) — sem 404.
Bodyapplication/json

Examples
{
    "id": "50d0d09e-a199-4f44-8817-e2345ee5948a",
    "name": "Triagem",
    "description": "",
    "workflowId": "84b6cb66-f42f-41b6-bfac-d5f4c91453d7",
    "icon": "",
    "orderColumn": 0,
    "active": true,
    "finisher": false,
    "impactSlaGeral": true,
    "statusId": 1,
    "createdAt": "2024-02-16T13:16:56.050Z",
    "updatedAt": "2024-02-16T13:16:56.050Z"
}
🟠401Não Autorizado
Modificado em 2026-05-28 20:05:32
Página anterior
Listar workspaces e workflows acessíveis ao usuário
Próxima página
Listar tickets de uma ou mais fases (paginado)
Built with