Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.tarefy.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Visão geral

Cada usuário do Tarefy tem permissões granulares dentro da sua conta, configuradas pelo administrador. Essas permissões determinam quais endpoints da API o token JWT pode acessar. Quando uma requisição é feita a um endpoint que exige permissão, a API valida o token e:
  • Permite se o usuário tem a permissão necessária → resposta 2xx
  • Bloqueia se não tem → resposta 403 Forbidden

​
Descobrindo suas permissões

Pra saber quais permissões o token autenticado tem, use: 
curl https://app.tarefy.com/nodeapi/api/v2/users/me \
  -H "Authorization: Bearer SEU_TOKEN"
A resposta inclui um campo permissions com a lista das permissões concedidas ao usuário. Use esse array pra decidir client-side quais funcionalidades habilitar antes de chamar endpoints específicos — assim você evita 403 desnecessários.

​
Tratando 403 na sua integração

Mesmo verificando antes, ainda pode acontecer de receber 403 Forbidden (mudança de permissão pelo admin, mudança de conta, etc). Trate como: 
if (res.status === 403) {
  // O usuário perdeu permissão pra esse endpoint
  // → atualizar UI / mostrar mensagem clara / fallback
}
A resposta vem com: 
{
  "message": "Forbidden",
  "code": "INSUFFICIENT_PERMISSION"
}

​
Permissões por endpoint

A documentação de cada endpoint na Referência da API indica explicitamente se há permissão necessária. Geralmente endpoints de:
  • Leitura (GET) — exigem ler o recurso
  • Escrita (POST/PATCH/PUT) — exigem editar o recurso
  • Administração — exigem permissão administrativa específica
As permissões disponíveis são definidas pelo administrador da conta no painel do Tarefy. Pra um usuário ganhar acesso a um endpoint específico, o administrador da conta precisa conceder a permissão correspondente.

​
Erros relacionados a permissão

StatusCenário
401 UnauthorizedToken ausente, inválido ou expirado
403 ForbiddenToken válido, mas sem a permissão exigida
404 Not FoundAlgumas APIs retornam 404 em vez de 403 quando o usuário não tem permissão de ler o recurso (evita vazar existência)
Veja Erros para o padrão completo de erros da API.