Gupy API: what you can do and how to use it with AI agents
Gupy is a Brazilian recruiting platform. Its API lets you look up jobs, applications and hiring process stages and receive events by webhook. HR teams and integrators who connect recruiting to payroll, onboarding and internal communication use it. Access is through a token generated for the customer company in Gupy.
What the Gupy API offers
Jobs
Look up jobs, requirements, status and owners.
Applications
Each job's candidates and the stage they are in.
Process stages
Move candidates between phases of the hiring process.
Webhooks
Notices of events such as a stage change and a hire.
Hiring data
Information on the approved candidate to move on to onboarding.
How to access the Gupy API
- With your company’s credentialsAn API token generated in the company's Gupy account, sent in the header as a bearer token. The permissions and features available depend on the contract.
- Decisions about candidates must be human: the agent organizes and reminds.
- Candidate data is personal and sometimes sensitive (LGPD, Brazil's data-protection law).
- Respect request limits and use webhooks for events.
Official documentation: developers.gupy.io
What an iTeam agent does with the Gupy API
Managers kept informed without asking
Every Monday, the agent sends each manager the funnel for their jobs: how many candidates per stage and who is waiting for their review.
Candidate stuck at a stage
The agent points out applications with no movement for days and reminds the recruiter or the responsible manager.
Onboarding triggered by the hire
When Gupy records the hire, the agent opens the onboarding process and asks the new employee for documents.
Interview scheduling
The agent checks the manager's calendar and proposes times to candidates approved at screening.
From the credential to the agent at work, with approval
Generate the token in Gupy
With an administrator, create the API token and confirm which features are released in the contract.
Register it in the iTeam vault
The token stays in the vault and only the HR agents use it, with reading kept separate from moving candidates.
Test with approval
Moving or rejecting candidates always goes through human approval.
Ready-made AI teams that use Gupy
Questions about the Gupy API
Is the Gupy API free?
Generally, API access is tied to the contract with Gupy. Confirm with your account contact whether it is included.
Do I need to code to use the Gupy API with iTeam?
Not necessarily. iTeam's HTTP tool reads the documentation and the deployment team sets up the flows.
Does the agent reject candidates on its own?
It should not. In iTeam, stage changes stay under the approval of whoever runs the process.
