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

# JOIN

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

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

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span className="connector-page-tag-preview connector-page-stage-tag">Preview</span><span>v1.1.0</span></div>
    <div><a href="/connectors/join/changelog">See changelog</a></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">23 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 Token" href="/connectors/join/guides/connector-profile/api-token" icon="https://stackone-logos.com/api/join/filled/svg" horizontal>
        Requires an API token generated from User Settings > API. Tokens can be revoked at any time.
      </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 Token" href="/connectors/join/guides/link-account/api-token" icon="https://stackone-logos.com/api/join/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>
  </div>

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

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid">
      <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>

      <div className="connector-meta-library-row" data-action-id="join_list_jobs" data-action-label="List Jobs" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Jobs</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_list_jobs" aria-label="Copy join_list_jobs"><code className="connector-page-code">join\_list\_jobs</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a list of jobs</div>
      </div>

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

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

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

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

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

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

      <div className="connector-meta-library-row" data-action-id="join_change_job_status" data-action-label="Change Job Status" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Change Job Status</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_change_job_status" aria-label="Copy join_change_job_status"><code className="connector-page-code">join\_change\_job\_status</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Change the status of a job</div>
      </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a list of applications</div>
      </div>

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

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

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

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

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete an application</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="join_update_application_external_data" data-action-label="Update Application Integration Data" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Application Integration Data</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_update_application_external_data" aria-label="Copy join_update_application_external_data"><code className="connector-page-code">join\_update\_application\_external\_data</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update the integration external ID for an application</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="join_list_application_scorecards" data-action-label="List Application Scorecards" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Application Scorecards</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_list_application_scorecards" aria-label="Copy join_list_application_scorecards"><code className="connector-page-code">join\_list\_application\_scorecards</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve scorecards for an application</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="join_update_candidate" data-action-label="Update Candidate" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Candidate</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_update_candidate" aria-label="Copy join_update_candidate"><code className="connector-page-code">join\_update\_candidate</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update a candidate's tags</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="join_list_candidate_notes" data-action-label="List Candidate Notes" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Candidate Notes</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_list_candidate_notes" aria-label="Copy join_list_candidate_notes"><code className="connector-page-code">join\_list\_candidate\_notes</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve notes for a candidate</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="join_create_candidate_note" data-action-label="Create Candidate Note" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Candidate Note</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_create_candidate_note" aria-label="Copy join_create_candidate_note"><code className="connector-page-code">join\_create\_candidate\_note</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a note for a candidate</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="join_update_candidate_note" data-action-label="Update Candidate Note" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Candidate Note</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_update_candidate_note" aria-label="Copy join_update_candidate_note"><code className="connector-page-code">join\_update\_candidate\_note</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update a candidate note</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="join_delete_candidate_note" data-action-label="Delete Candidate Note" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Candidate Note</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_delete_candidate_note" aria-label="Copy join_delete_candidate_note"><code className="connector-page-code">join\_delete\_candidate\_note</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a candidate note</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="join_list_offices" data-action-label="List Offices" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Offices</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_list_offices" aria-label="Copy join_list_offices"><code className="connector-page-code">join\_list\_offices</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a list of offices</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="join_get_office" data-action-label="Get Office" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Office</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_get_office" aria-label="Copy join_get_office"><code className="connector-page-code">join\_get\_office</code></button></div>
        </div>

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

      <div className="connector-meta-library-row" data-action-id="join_create_office" data-action-label="Create Office" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Office</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_create_office" aria-label="Copy join_create_office"><code className="connector-page-code">join\_create\_office</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new office</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="join_update_office" data-action-label="Update Office" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Office</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_update_office" aria-label="Copy join_update_office"><code className="connector-page-code">join\_update\_office</code></button></div>
        </div>

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

      <div className="connector-meta-library-row" data-action-id="join_list_categories" data-action-label="List Categories" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Categories</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_list_categories" aria-label="Copy join_list_categories"><code className="connector-page-code">join\_list\_categories</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a list of job categories</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="join_list_employment_types" data-action-label="List Employment Types" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Employment Types</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_list_employment_types" aria-label="Copy join_list_employment_types"><code className="connector-page-code">join\_list\_employment\_types</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a list of employment types</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="join_list_seniority_levels" data-action-label="List Seniority Levels" data-action-scopes="" data-action-auth="API Token" data-action-auth-scopes="{&#x22;API Token&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Seniority Levels</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="join_list_seniority_levels" aria-label="Copy join_list_seniority_levels"><code className="connector-page-code">join\_list\_seniority\_levels</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a list of seniority levels</div>
      </div>
    </div>
  </div>
</div>


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