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.
Conceitos básicos
A API do Tarefy trabalha com 2 conceitos principais:- Conta — a organização que assina o Tarefy (uma empresa, agência ou consultoria)
- Usuário — uma pessoa que acessa o Tarefy
Conta ativa no token
Quando você faz login viaPOST /api/v2/auth/login, o token JWT retornado já vem com uma conta específica como contexto. Todas as chamadas seguintes operam dentro dessa conta.
Se o usuário pertence a múltiplas contas, o login retorna a conta padrão dele. Pra alternar de conta, é necessário fazer login novamente especificando a conta desejada (consulte o endpoint de login na referência da API).
Níveis de acesso
Cada usuário tem um nível dentro da conta, que determina o que ele consegue fazer via API:| Nível | Papel típico | Permissões |
|---|---|---|
| 1 | Owner | Total |
| 2 | Admin | Quase total (exceto billing) |
| 3 | Gestor | Gestão de time e relatórios |
| 4 | Colaborador | Tarefas e operação no dia a dia |
| 5 | Externo | Visão limitada (clientes, parceiros) |
Endpoints principais
| Endpoint | Uso |
|---|---|
GET /api/v2/users | Listar usuários da conta atual |
GET /api/v2/users/me | Dados do usuário autenticado |
POST /api/v2/users | Convidar um novo usuário |
PATCH /api/v2/users/{id} | Atualizar dados de um usuário |
GET /api/v2/accounts/{id} | Detalhes da conta |