Listar fases por board

Retorna todas as fases vinculadas a um Board específico, identificado pelo seu ID.

Este endpoint permite consultar a estrutura completa do fluxo de um Board, retornando as fases cadastradas e organizadas dentro do processo.

É recomendado para integrações que necessitam identificar as etapas disponíveis de um Board antes de realizar operações como criação de cards, movimentações entre fases, automações ou consultas específicas.

Parâmetros utilizados

id do Board

Identificador único do Board que será consultado.

O ID deve ser informado diretamente na rota da requisição.

Exemplo:

GET https://api.goalfy.com.br/api/phases/board/12345

Neste exemplo:

12345

Corresponde ao ID do Board consultado.

Exemplo de Resposta

[
    {
        "alwaysAssignResponsible": false,
        "archived": false,
        "color": "--choice-gray-900",
        "description": "Fase que recebe todos os cards novos.",
        "id": "12345",
        "index": 0.0,
        "modelId": "12345",
        "orderByCard": "CREATION_DATE_DESC",
        "phaseResponsibleConfig": "SEQUENTIAL",
        "phasesToMove": [
          	{
              ...
						}
        ],
        "replaceResponsible": false,
        "slaConsiderOnlyBusinessDays": false,
        "slaTimeBeforeDue": "0;minutes",
        "slaTimeBeforeDueEnabled": false,
        "title": "Caixa de Entrada",
        "totalizerEnabled": false
     }
]

Observações

🚧

Importante

O retorno da requisição pode variar conforme as permissões do usuário autenticado.

• As fases retornadas pertencem exclusivamente ao Board informado.
• A ordem das fases geralmente representa o fluxo configurado dentro do Board.
• Os IDs das fases podem ser utilizados posteriormente em endpoints relacionados a cards, movimentações e consultas específicas.
• Boards sem fases configuradas podem retornar uma lista vazia.
• Recomenda-se armazenar os IDs das fases para facilitar futuras integrações.

FAQ?

Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas: