Pesquisar o Board pelo Título

Retorna uma lista de Boards com base em uma busca textual realizada pelo nome do Board.

Este endpoint permite localizar Boards específicos dentro da organização utilizando um termo de pesquisa (query), facilitando integrações que necessitam encontrar Boards dinamicamente sem a necessidade de conhecer previamente o ID.

A busca é realizada a partir do título/nome do Board informado na requisição.

Parâmetros utilizados

query

Texto utilizado para realizar a pesquisa do Board.

O valor deve ser informado diretamente como parâmetro na URL da requisição.

Exemplo:

GET https://api.goalfy.com.br/api/boards/search?query={nome}

Neste exemplo:

comercial

Corresponde ao termo utilizado para localizar Boards relacionados.

Exemplo de resposta

[ 
  { 
    "id": "10001", 
    "name": "Comercial", 
    "description": "Board responsável pelo fluxo comercial" 
  }, 
  { 
		"id": "10002", 
   	"name": "Comercial - SDR", 
  	"description": "Pré-vendas" 
  } 
]

Observações

🚧

Importante

O retorno da pesquisa pode variar conforme as permissões do usuário autenticado.

• A pesquisa é realizada utilizando o nome/título do Board.
• Dependendo da quantidade de Boards cadastrados, múltiplos resultados podem ser retornados.
• Caso nenhum Board seja encontrado, a resposta poderá retornar uma lista vazia.
• Recomenda-se utilizar termos objetivos para obter resultados mais precisos.
• Os IDs retornados podem ser utilizados posteriormente em endpoints relacionados a cards e fases.

FAQ?

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