Ir para o conteúdo
Promovaweb

Consulte tarefas pela API

Revisado em

Antes de começar

Autentique uma consulta da API e confira o identificador e as permissões da identidade autenticada.

  • Token pessoal autorizado ou integração OAuth.
  • Node.js e ID de tarefa acessível.

A API do ClickUp exige autenticação. Tokens pessoais atendem a usos individuais, enquanto aplicações usadas por outros usuários devem seguir o fluxo OAuth indicado na documentação.

Prepare a consulta

Use um token autorizado e mantenha-o em uma variável de ambiente configurada fora do código. O exemplo espera CLICKUP_TOKEN e CLICKUP_TASK_ID. Ele consulta uma tarefa, sem alterar o registro.

const token = process.env.CLICKUP_TOKEN
const taskId = process.env.CLICKUP_TASK_ID
if (!token || !taskId) throw new Error('Configure token e ID da tarefa.')
const response = await fetch(
'https://api.clickup.com/api/v2/task/' + encodeURIComponent(taskId),
{ headers: { Authorization: token } }
)
if (!response.ok) throw new Error('Consulta recusada: HTTP ' + response.status)
const task = await response.json()
console.log({ id: task.id, nome: task.name, status: task.status?.status })

Execute o exemplo com uma tarefa conhecida

Grave o exemplo em um arquivo chamado consulta-clickup.mjs e execute com uma versão do Node.js que disponibilize fetch. Configure as variáveis de ambiente no processo que executará o arquivo. O token deve continuar fora do repositório e de capturas enviadas ao suporte.

Use o ID nativo de uma tarefa de estudo que você consiga consultar com o mesmo perfil. Um identificador personalizado pode exigir parâmetros adicionais no endpoint. Para a primeira consulta, confirme na documentação de Get Task qual formato o exemplo espera antes de adaptar o endereço.

A saída mostra somente ID, nome e status para facilitar a comparação e evitar imprimir toda a descrição. Abra a tarefa no navegador e confira esses campos. Se o nome estiver correto, mas o ID for diferente, investigue antes de acrescentar qualquer chamada de escrita.

Interprete a recusa antes de tentar novamente

Quando a API devolver erro, registre o código HTTP e a mensagem permitida para diagnóstico. Uma credencial inválida, uma permissão insuficiente e um identificador incorreto exigem verificações diferentes. Repetir a mesma requisição com frequência não corrige essas causas.

O HTTP 429 indica que o limite de requisições foi atingido. Examine os cabeçalhos de limite e de reinício da janela informados pela API antes de programar novas tentativas. Em uma integração com várias tarefas, controle a frequência das consultas e preserve o registro das que já terminaram.

Prepare a integração

A API respeita o acesso do perfil autenticado. Quando houver escrita, confira o corpo exigido pelo endpoint e releia o recurso depois da alteração.

Use os webhooks quando o fluxo precisar reagir a eventos, evitando consultas repetidas sem necessidade.

Confira o resultado

A API retorna a tarefa esperada sem expor o token nos registros da aplicação.

Fontes e conferência

Procedimento conferido na documentação indicada. Não executado em um Workspace de laboratório. A disponibilidade e os nomes da interface podem variar conforme o plano, a função e a versão.