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

# Apploi

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

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/apploi/filled/svg" alt="Apploi" 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">25 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/apploi/guides/connector-profile/api-key" icon="https://stackone-logos.com/api/apploi/filled/svg" horizontal>
        Apploi uses a partner API key sent in the X-Api-Key header. Your API key is issued by Apploi when you register as a part...
      </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/apploi/guides/link-account/api-key" icon="https://stackone-logos.com/api/apploi/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>25 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="apploi_list_applicants" data-action-label="List Applicants" 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>List Applicants</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_list_applicants" aria-label="Copy apploi_list_applicants"><code className="connector-page-code">apploi\_list\_applicants</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a paginated list of job applicants, optionally filtered by state, job, team, or date range.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_create_applicant" data-action-label="Create Applicant" 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>Create Applicant</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_create_applicant" aria-label="Copy apploi_create_applicant"><code className="connector-page-code">apploi\_create\_applicant</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new job applicant record in Apploi.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_get_applicant" data-action-label="Get Applicant" 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>Get Applicant</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_get_applicant" aria-label="Copy apploi_get_applicant"><code className="connector-page-code">apploi\_get\_applicant</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a single applicant by their application form ID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_update_applicant" data-action-label="Update Applicant" 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>Update Applicant</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_update_applicant" aria-label="Copy apploi_update_applicant"><code className="connector-page-code">apploi\_update\_applicant</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing applicant by adding notes to their application.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_list_applicant_statuses" data-action-label="List Applicant Statuses" 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>List Applicant Statuses</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_list_applicant_statuses" aria-label="Copy apploi_list_applicant_statuses"><code className="connector-page-code">apploi\_list\_applicant\_statuses</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve the list of available applicant statuses configured for a team.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_update_applicant_status" data-action-label="Update Applicant Status" 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>Update Applicant Status</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_update_applicant_status" aria-label="Copy apploi_update_applicant_status"><code className="connector-page-code">apploi\_update\_applicant\_status</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update the status of one or more job applications in bulk.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_schedule_interview" data-action-label="Schedule Interview" 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>Schedule Interview</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_schedule_interview" aria-label="Copy apploi_schedule_interview"><code className="connector-page-code">apploi\_schedule\_interview</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Schedule or cancel an interview for a job applicant.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_list_applicant_messages" data-action-label="List Applicant Messages" 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>List Applicant Messages</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_list_applicant_messages" aria-label="Copy apploi_list_applicant_messages"><code className="connector-page-code">apploi\_list\_applicant\_messages</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all messages associated with a job applicant.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_send_applicant_message" data-action-label="Send Applicant Message" 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>Send Applicant Message</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_send_applicant_message" aria-label="Copy apploi_send_applicant_message"><code className="connector-page-code">apploi\_send\_applicant\_message</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Send a text or email message to a job applicant.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_get_applicant_preconfigured_documents" data-action-label="Get Applicant Preconfigured Documents" 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>Get Applicant Preconfigured Documents</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_get_applicant_preconfigured_documents" aria-label="Copy apploi_get_applicant_preconfigured_documents"><code className="connector-page-code">apploi\_get\_applicant\_preconfigured\_documents</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve preconfigured documents associated with a job applicant.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_submit_background_check_result" data-action-label="Submit Background Check Result" 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>Submit Background Check Result</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_submit_background_check_result" aria-label="Copy apploi_submit_background_check_result"><code className="connector-page-code">apploi\_submit\_background\_check\_result</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Submit the result of a background check for a job applicant.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_check_already_applied" data-action-label="Check Already Applied" 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>Check Already Applied</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_check_already_applied" aria-label="Copy apploi_check_already_applied"><code className="connector-page-code">apploi\_check\_already\_applied</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Check whether a person has already applied to a specific job.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_list_jobs" data-action-label="List Jobs" 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>List Jobs</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_list_jobs" aria-label="Copy apploi_list_jobs"><code className="connector-page-code">apploi\_list\_jobs</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all job postings for the connected Apploi account.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_get_job" data-action-label="Get Job" 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>Get Job</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_get_job" aria-label="Copy apploi_get_job"><code className="connector-page-code">apploi\_get\_job</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a single job posting by its ID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_create_job" data-action-label="Create Job" 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>Create Job</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_create_job" aria-label="Copy apploi_create_job"><code className="connector-page-code">apploi\_create\_job</code></button></div>
        </div>

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

      <div className="connector-meta-library-row" data-action-id="apploi_update_job" data-action-label="Update Job" 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>Update Job</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_update_job" aria-label="Copy apploi_update_job"><code className="connector-page-code">apploi\_update\_job</code></button></div>
        </div>

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

      <div className="connector-meta-library-row" data-action-id="apploi_search_jobs" data-action-label="Search Jobs" 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>Search Jobs</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_search_jobs" aria-label="Copy apploi_search_jobs"><code className="connector-page-code">apploi\_search\_jobs</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Search for job postings matching specified criteria with pagination support.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_list_job_cities" data-action-label="List Job Cities" 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>List Job Cities</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_list_job_cities" aria-label="Copy apploi_list_job_cities"><code className="connector-page-code">apploi\_list\_job\_cities</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve the list of cities where jobs are available.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_list_job_industries" data-action-label="List Job Industries" 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>List Job Industries</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_list_job_industries" aria-label="Copy apploi_list_job_industries"><code className="connector-page-code">apploi\_list\_job\_industries</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve the list of industries that have active job postings.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_upsert_job_attributes" data-action-label="Upsert Job Attributes" 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>Upsert Job Attributes</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_upsert_job_attributes" aria-label="Copy apploi_upsert_job_attributes"><code className="connector-page-code">apploi\_upsert\_job\_attributes</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create or update custom job attributes for a team.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_update_ai_chat_subscription" data-action-label="Update AI Chat Subscription" 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>Update AI Chat Subscription</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_update_ai_chat_subscription" aria-label="Copy apploi_update_ai_chat_subscription"><code className="connector-page-code">apploi\_update\_ai\_chat\_subscription</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Enable or disable AI chat for specific jobs within a team.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_list_application_form_templates" data-action-label="List Application Form Templates" 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>List Application Form Templates</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_list_application_form_templates" aria-label="Copy apploi_list_application_form_templates"><code className="connector-page-code">apploi\_list\_application\_form\_templates</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve application form templates available for a team.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_upsert_document_merge_fields" data-action-label="Upsert Document Merge Fields" 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>Upsert Document Merge Fields</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_upsert_document_merge_fields" aria-label="Copy apploi_upsert_document_merge_fields"><code className="connector-page-code">apploi\_upsert\_document\_merge\_fields</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create or update merge fields for a document template.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_get_analytics_job_click" data-action-label="Get Analytics Job Click" 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>Get Analytics Job Click</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_get_analytics_job_click" aria-label="Copy apploi_get_analytics_job_click"><code className="connector-page-code">apploi\_get\_analytics\_job\_click</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Record and retrieve analytics data for a job click event.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="apploi_get_analytics_search" data-action-label="Get Analytics Search" 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>Get Analytics Search</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="apploi_get_analytics_search" aria-label="Copy apploi_get_analytics_search"><code className="connector-page-code">apploi\_get\_analytics\_search</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve search analytics data with optional location and filter parameters.</div>
      </div>
    </div>
  </div>
</div>