> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Homerun

> How to set up the Homerun connector, plus the actions that are available.

![Homerun](https://stackone-logos.com/api/homerun/filled/svg)

Betav1.1.0[See changelog](https://docs.stackone.com/connectors/homerun/changelog.md)

[11 actions](#actions) · 1 auth method

ATS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/homerun/guides/connector-profile/api-key.md)
>
> Requires an API key generated from the Integrations Page in the Homerun App. Scopes are assigned at key creation and can...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/homerun/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

job-application-files:write

job-application-notes:write

job-applications:read

job-applications:write

vacancies:read

No scopes found

11 actions

ActionDescriptionRequired scopes

List Job Applications`homerun_list_job_applications`

Retrieve a paginated list of job applications with optional filtering and related data inclusion.

`job-applications:read`

Create Job Application`homerun_create_job_application`

Create a new job application in Homerun.

`job-applications:write`

Get Job Application`homerun_get_job_application`

Retrieve a specific job application by ID.

`job-applications:read`

Update Job Application`homerun_update_job_application`

Update an existing job application.

`job-applications:write`

Delete Job Application`homerun_delete_job_application`

Delete a job application by ID.

`job-applications:write`

List Vacancies`homerun_list_vacancies`

Retrieve a paginated list of vacancies with optional filtering and related data inclusion.

`vacancies:read`

Get Vacancy`homerun_get_vacancy`

Retrieve a specific vacancy by ID.

`vacancies:read`

Create Note`homerun_create_note`

Create a note on a job application.

`job-application-notes:write`

Upload File`homerun_upload_file`

Upload a file (resume or assignment) to a job application.

`job-application-files:write`

Upload Photo`homerun_upload_photo`

Upload a photo to a job application.

`job-application-files:write`

Ping`homerun_ping`

Test endpoint to verify API key authentication is working.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.