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.

Core concepts

The Tarefy API works with two main concepts:
  • Account — the organization that subscribes to Tarefy (a company, agency or consultancy)
  • User — a person who accesses Tarefy
A single user can belong to multiple accounts — for example, a consultant serving several companies, or a professional working in more than one agency.

Active account in the token

When you sign in via POST /api/v2/auth/login, the JWT token returned already has a specific account as context. All subsequent calls operate within that account. If the user belongs to multiple accounts, login returns their default account. To switch accounts, log in again specifying the desired account (see the login endpoint in the API reference).

Access levels

Each user has a level within the account that determines what they can do via the API:
LevelTypical rolePermissions
1OwnerFull access
2AdminNear-full (except billing)
3ManagerTeam management and reports
4MemberDay-to-day tasks and operations
5ExternalLimited view (clients, partners)
Endpoints requiring specific permissions return 403 Forbidden when the user does not have the right level. See Permissions for details.

Main endpoints

EndpointUse
GET /api/v2/usersList users in the current account
GET /api/v2/users/meAuthenticated user data
POST /api/v2/usersInvite a new user
PATCH /api/v2/users/{id}Update a user
GET /api/v2/accounts/{id}Account details
See the full API reference for every endpoint, parameter and example.