All Collections
Company settings
Advanced
Does Homerun offer an API?
Does Homerun offer an API?
Jennifer avatar
Written by Jennifer
Updated over a week ago

This feature is available in our Plus plan

Yes, Homerun offers a public API to users on the Plus plan.

What is an API?

An API, or Application Programming Interface, is like a messenger that allows different software programs to talk to each other and share information, making it easier for them to work together and accomplish tasks. A public API is designed to be accessible and used by external developers and third-party applications. It’s made available to the public (hence the name) and typically follows certain standards and protocols to ensure compatibility and ease of integration.


A public API can help you easily connect and share candidate information and other data with other systems or platforms you use – for example, CRM, HR and analytics tools. This saves you time and effort, eliminates the need for manual data entry and ensures your hiring process is efficient and streamlined.

Requesting an API key

The admin of your account can request our API by following these steps:

  1. From anywhere in the tool, click Settings in the sidebar

  2. Click Integrations in the Customize section

  3. Scroll down to the last block on the page, API

  4. Click the green button Generate API key. The key will now be generated

  5. After that, click the blue button Show API key. A small window will pop up with the key and the documentation.

Send us a message if you have any questions about our API, we'd be happy to answer them for you! But please note that we do not offer support with setting up an API.

Deleting the API key

  1. From anywhere in the tool, click Settings in the sidebar

  2. Click Integrations, displayed at Customize

  3. Scroll down to the last block on the page, API

  4. At Your API Key, click Delete API Key

  5. Note that you can no longer use the API Key in your custom integrations. Click Confirm.

Did this answer your question?