The Homerun Public API gives you programmatic access to your hiring data and lets you build integrations with the other tools your team uses, from CRM and HR systems to custom dashboards and automations.
This article covers what's possible with the API. To learn how to generate your API key, see How to generate our public API key. For full technical documentation, visit developers.homerun.co.
Jobs
Get your jobs, including the job page content, salary range, and number of candidates per job.
Get the questions on a job's application form.
Candidates
Add new candidates to a job.
Read all of your candidates.
Update a candidate's details.
Move a candidate to another job.
Move a candidate to another stage in the hiring process.
Mark a candidate as sourced rather than having applied themselves.
See where an application came from (for example Indeed, LinkedIn, or Google).
See why a candidate was disqualified.
Delete a candidate.
Application form answers and files
Submit a candidate's answers to a job's application form questions.
Upload files to a candidate, such as a CV or portfolio.
Upload a candidate's profile photo.
Notes
Add, read, edit, and delete notes on any candidate's profile.
Tags
Create, rename, and delete your company's tags.
Add tags to a candidate or remove them.
Emails
Send a candidate the confirmation email for their application. This can be sent once per application.
Privacy and data retention
Set the data retention date for individual candidates, helping you stay compliant with your data policies.
What's required
Admin access, only admins can generate and manage API keys.
Paid plan, the Public API is available on paid plans. Trials are excluded.
Scopes, when generating a key, you select which scopes (permissions) to include. Scopes cannot be changed after the key is created.
Please note that we do not offer support for setting up integrations with other tools using our API.
Have more questions about the API? Ask for a Human Agent in our live chat!