Skip to main content

How to generate our public API key

Written by Héctor

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.
​

The Homerun Public API lets you connect your hiring data with other systems you use, such as CRM, HR, and analytics tools. This saves time, eliminates manual data entry, and keeps your hiring process streamlined. For a full overview of what's possible, see What can you do with the Homerun Public API?.

Before you start

  • Admins only. Only account admins can generate and manage API keys.

  • Paid plans only. The Public API is available on paid plans. Trials do not have access.

  • Maximum 10 active keys. You can have up to 10 active API keys per account at the same time.

Generating an API key

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

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

  2. Go to Company → Public API.

  3. Click Generate V2 API key. A modal will open.

  4. Select the Scopes you want to include. Keep in mind that scopes cannot be changed after the key is created — if you need different scopes later, you'll need to generate a new key.

  5. Optionally, set an Expiry date for the key.

  6. Click Generate in the modal.

  7. Your API key will be displayed once. Copy it and store it somewhere safe — we will only show it to you at this moment.

  8. Click Done to close the modal.

The key is shown only once, immediately after generation. If you lose it, you'll need to delete it and generate a new one.

Please note that we do not offer support for setting up integrations with other tools using our API.

Deleting the API key

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

  2. Go to Company → Public API.

  3. Under Your API Keys, click Delete API Key next to the key you want to remove.

  4. Note that deleting a key means any integrations using it will stop working. Click Confirm.

Developer documentation

For full technical documentation on endpoints, authentication, and request examples, visit developers.homerun.co.
​

If you have questions about our API, feel free to reach out via live chat!

Related Articles
Did this answer your question?