What the API Offers
When you invite candidates, each gets a unique link, and you choose whether Equip sends the invitation email (it does by default) and how many days the link stays valid.
Every API request acts as your team’s admin recruiter. A write on a read-only endpoint returns “API key authentication is read-only for this endpoint”; any endpoint outside the allowed list returns “API key authentication is not allowed for this endpoint”.
Costs
API access is part of the Integrations & Webhooks feature on the Elite plan, with no separate setup fee or minimum purchase.Credits work the same way for API-driven invitations as for dashboard invitations. See How Credits Work for deduction and reclaim rules.
Getting Access
Every team has one API Key, generated by the team admin.1
Create a team and trial Equip
Sign up for a recruiter account at equip.co with your work email. Use your free signup credits to confirm the product works for your use case.
2
Subscribe to Elite
See How Credits Work for how to subscribe.
3
Generate your API Key
On Account → Developers, click Generate API Key and copy the key. It is shown only once; if you lose it, click Rotate API Key to get a new one.
Explore the APIs
A public Postman collection documents the available endpoints. You can browse it freely, but every request needs your team’s API Key. For a walkthrough of wiring the pieces together, follow this integration guide.Related Resources
- Webhooks - Get completed assessment and interview results pushed to your endpoint
- How Credits Work - Purchasing, pricing, and how credits are deducted
- Write Results to Google Sheets - A no-code way to export results automatically
- AI Interview Reports - What an AI interview result contains
