Convenia API: what you can do and how to use it with AI agents
Convenia, a Brazilian HR platform, offers an API to access employee data, hiring, terminations, vacation and other people-operations information. Companies that want to connect HR to payroll, benefits and internal systems use it. Access is with a token generated in the company's account.
What the Convenia API offers
Employees
Query and update personal and contract records.
Hiring
Follow the digital hiring process.
Terminations
Record and look up terminations.
Vacation and absences
Vacation periods and leaves.
Company structure
Departments, job titles and cost centers.
How to access the Convenia API
- With your company’s credentialsUses an API token generated on the Convenia platform by an administrator and sent in the request header.
- Employee data is personal and some of it is sensitive (Brazil's data-protection law, LGPD).
- Answers to employees must respect who can see what.
- Changes to employee records need HR approval.
What an iTeam agent does with the Convenia API
Onboarding for new hires
When hiring is completed, the agent creates accounts, notifies the manager and sends the new employee their first-week schedule.
Vacation questions in Teams
An employee asks for their vacation balance, and the agent looks it up and answers only to people entitled to see it.
Termination checklist
When a termination is recorded, the agent opens the tasks for removing access and returning equipment.
Monthly headcount report
The agent gathers hires, terminations and headcount by area and sends them to HR.
From the credential to the agent at work, with approval
Generate the token
A Convenia administrator generates the company's API token.
Store it in the iTeam vault
Add the token and restrict access to HR agents, with sensitive fields blocked where possible.
Validate with HR
Test with a small group and keep changes to employee records under approval.
Ready-made AI teams that use Convenia
Questions about the Convenia API
Is the Convenia API free?
API access depends on the plan you contracted. Confirm with Convenia whether it is included in your account.
Do I need to write code to use the Convenia API with iTeam?
Not necessarily. The iTeam deployment team sets up the integration from Convenia's documentation.
Does the agent calculate payroll?
No. Payroll stays in the payroll system. The agent handles routines, questions and the integrations around it.
