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

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/homerun/filled/svg" alt="Homerun" className="connector-page-icon" />

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span className="connector-page-tag-beta connector-page-stage-tag">Beta</span><span>v1.0.0</span></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">11 actions</a> · 1 auth method</div>

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">ATS</span>
    </div>
  </div>
</div>

## Getting Started

<Steps>
  <Step title="Create or Select a Project">
    Set up a new project or select an existing one. See [Organizations & Projects](/gateway/concepts/organizations-and-projects).
  </Step>

  <Step title="Configure the Connector">
    Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](/gateway/quickstart#setup-connector-profile).

    <Columns cols={2}>
      <Card title="Connector Profile · API Key" href="/connectors/homerun/guides/connector-profile/api-key" icon="https://stackone-logos.com/api/homerun/filled/svg" horizontal>
        Requires an API key generated from the Integrations Page in the Homerun App. Scopes are assigned at key creation and can...
      </Card>
    </Columns>
  </Step>

  <Step title="Link an Account">
    Link an account [from the dashboard](/connect/managing-connectors/linking-accounts#link-from-the-dashboard) (or via [StackOne Hub](/embed/account-linking/overview)).

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

    <Columns cols={2}>
      <Card title="Link Account · API Key" href="/connectors/homerun/guides/link-account/api-key" icon="https://stackone-logos.com/api/homerun/filled/svg" horizontal />
    </Columns>
  </Step>

  <Step title="Use Actions">
    Connect an AI platform to the linked account's actions. See [AI Platforms](/connect/ai-platforms/overview).

    Other ways to call actions are listed in [Protocols & SDKs](/connect/protocols-and-sdks).
  </Step>
</Steps>

## Actions

<div className="connector-meta-library-section">
  <div className="connector-actions-controls not-prose" data-connector-actions-controls>
    <div className="connector-actions-controls__row">
      <input type="search" className="connector-actions-search" data-connector-actions-search placeholder="Search actions" aria-label="Search actions" />

      <div className="connector-actions-scopes" data-connector-actions-scopes>
        <button type="button" className="connector-actions-scopes__toggle" data-connector-actions-scopes-toggle aria-expanded="false">
          <span>Scopes<span data-connector-actions-scopes-count /></span>
        </button>

        <div className="connector-actions-scopes__menu">
          <div className="connector-actions-scopes__header">
            <input type="search" className="connector-actions-scopes__search" data-connector-actions-scope-search placeholder="Search scopes..." aria-label="Search scopes" />

            <div className="connector-actions-scopes__actions">
              <button type="button" data-connector-actions-scopes-select-all>Select all</button>
              <span>|</span>
              <button type="button" data-connector-actions-scopes-clear>Clear</button>
            </div>
          </div>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="job-application-files:write" data-connector-actions-scope-filter />

            <span>job-application-files:write</span>
          </label>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="job-application-notes:write" data-connector-actions-scope-filter />

            <span>job-application-notes:write</span>
          </label>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="job-applications:read" data-connector-actions-scope-filter />

            <span>job-applications:read</span>
          </label>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="job-applications:write" data-connector-actions-scope-filter />

            <span>job-applications:write</span>
          </label>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="vacancies:read" data-connector-actions-scope-filter />

            <span>vacancies:read</span>
          </label>

          <div className="connector-actions-scopes__empty" data-connector-actions-scopes-empty hidden>No scopes found</div>
        </div>
      </div>
    </div>
  </div>

  <div className="meta-library-count" data-connector-actions-count>11 actions</div>

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid connector-meta-library-grid--three-col">
      <div className="connector-meta-library-row">
        <div className="meta-library-grid-header-cell">Action</div>
        <div className="meta-library-grid-header-cell">Description</div>
        <div className="meta-library-grid-header-cell">Required scopes</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="homerun_list_job_applications" data-action-label="List Job Applications" data-action-scopes="job-applications:read" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Job Applications</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="homerun_list_job_applications" aria-label="Copy homerun_list_job_applications"><code className="connector-page-code">homerun\_list\_job\_applications</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a paginated list of job applications with optional filtering and related data inclusion.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="job-applications:read" aria-label="Copy scope job-applications:read"><code className="connector-page-code">job-applications:read</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="homerun_create_job_application" data-action-label="Create Job Application" data-action-scopes="job-applications:write" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Job Application</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="homerun_create_job_application" aria-label="Copy homerun_create_job_application"><code className="connector-page-code">homerun\_create\_job\_application</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new job application in Homerun.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="job-applications:write" aria-label="Copy scope job-applications:write"><code className="connector-page-code">job-applications:write</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="homerun_get_job_application" data-action-label="Get Job Application" data-action-scopes="job-applications:read" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Job Application</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="homerun_get_job_application" aria-label="Copy homerun_get_job_application"><code className="connector-page-code">homerun\_get\_job\_application</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a specific job application by ID.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="job-applications:read" aria-label="Copy scope job-applications:read"><code className="connector-page-code">job-applications:read</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="homerun_update_job_application" data-action-label="Update Job Application" data-action-scopes="job-applications:write" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Job Application</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="homerun_update_job_application" aria-label="Copy homerun_update_job_application"><code className="connector-page-code">homerun\_update\_job\_application</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing job application.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="job-applications:write" aria-label="Copy scope job-applications:write"><code className="connector-page-code">job-applications:write</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="homerun_delete_job_application" data-action-label="Delete Job Application" data-action-scopes="job-applications:write" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Job Application</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="homerun_delete_job_application" aria-label="Copy homerun_delete_job_application"><code className="connector-page-code">homerun\_delete\_job\_application</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a job application by ID.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="job-applications:write" aria-label="Copy scope job-applications:write"><code className="connector-page-code">job-applications:write</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="homerun_list_vacancies" data-action-label="List Vacancies" data-action-scopes="vacancies:read" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Vacancies</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="homerun_list_vacancies" aria-label="Copy homerun_list_vacancies"><code className="connector-page-code">homerun\_list\_vacancies</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a paginated list of vacancies with optional filtering and related data inclusion.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="vacancies:read" aria-label="Copy scope vacancies:read"><code className="connector-page-code">vacancies:read</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="homerun_get_vacancy" data-action-label="Get Vacancy" data-action-scopes="vacancies:read" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Vacancy</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="homerun_get_vacancy" aria-label="Copy homerun_get_vacancy"><code className="connector-page-code">homerun\_get\_vacancy</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a specific vacancy by ID.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="vacancies:read" aria-label="Copy scope vacancies:read"><code className="connector-page-code">vacancies:read</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="homerun_create_note" data-action-label="Create Note" data-action-scopes="job-application-notes:write" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Note</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="homerun_create_note" aria-label="Copy homerun_create_note"><code className="connector-page-code">homerun\_create\_note</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a note on a job application.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="job-application-notes:write" aria-label="Copy scope job-application-notes:write"><code className="connector-page-code">job-application-notes:write</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="homerun_upload_file" data-action-label="Upload File" data-action-scopes="job-application-files:write" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Upload File</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="homerun_upload_file" aria-label="Copy homerun_upload_file"><code className="connector-page-code">homerun\_upload\_file</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Upload a file (resume or assignment) to a job application.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="job-application-files:write" aria-label="Copy scope job-application-files:write"><code className="connector-page-code">job-application-files:write</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="homerun_upload_photo" data-action-label="Upload Photo" data-action-scopes="job-application-files:write" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Upload Photo</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="homerun_upload_photo" aria-label="Copy homerun_upload_photo"><code className="connector-page-code">homerun\_upload\_photo</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Upload a photo to a job application.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="job-application-files:write" aria-label="Copy scope job-application-files:write"><code className="connector-page-code">job-application-files:write</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="homerun_ping" data-action-label="Ping" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Ping</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="homerun_ping" aria-label="Copy homerun_ping"><code className="connector-page-code">homerun\_ping</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Test endpoint to verify API key authentication is working.</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list" />
        </div>
      </div>
    </div>
  </div>
</div>