API Documentation
Avos External API
RESTful API to integrate your systems with payroll. API Key authentication, complete Swagger documentation.
Quick start
1
Create an API Key
In the dashboard, go to API Keys → New key. Set the required scopes.
2
Authenticate
Send the Authorization: Bearer pk_live_... header in all requests.
3
Make your first call
GET /api/external/v1/employees to list company employees.
Authentication example
curl https://api.useavos.app/api/external/v1/employees \ -H "Authorization: Bearer pk_live_sua_chave_aqui" \ -H "Content-Type: application/json"
Available resources
Employees
Read and manage employee data via API.
GETPOSTPATCHemployees:reademployees:write
Departments
Query and create company departments.
GETPOSTdepartments:readdepartments:write
Positions
Access positions and job structure.
GETPOSTpositions:readpositions:write
Payroll
Query, calculate and approve payroll via the API.
GETPOSTpayroll:readpayroll:write
Time clock
Query punches and register clock in/out events.
GETPOSTtimeclock:readtimeclock:write
Reports
Export payroll and headcount reports.
GETreports:read