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

# HiPeople

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

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

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span>v1.0.0</span></div>
    <div><a href="/connectors/hipeople/changelog">See changelog</a></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">3 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 · Email & Password" href="/connectors/hipeople/guides/connector-profile/email-password" icon="https://stackone-logos.com/api/hipeople/filled/svg" horizontal>
        HiPeople authenticates every REST request with a public/secret API key pair sent as the \`X-API-Key\` and \`X-API-Secret\` h...
      </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 · Email & Password" href="/connectors/hipeople/guides/link-account/email-password" icon="https://stackone-logos.com/api/hipeople/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>3 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="hipeople_list_open_job_roles" data-action-label="List Open Job Roles" data-action-scopes="" data-action-auth="Email & Password" data-action-auth-scopes="{&#x22;Email & Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Open Job Roles</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hipeople_list_open_job_roles" aria-label="Copy hipeople_list_open_job_roles"><code className="connector-page-code">hipeople\_list\_open\_job\_roles</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a paginated list of open job roles in your HiPeople organization.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hipeople_list_role_candidates" data-action-label="List Candidates For A Role" data-action-scopes="" data-action-auth="Email & Password" data-action-auth-scopes="{&#x22;Email & Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Candidates For A Role</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hipeople_list_role_candidates" aria-label="Copy hipeople_list_role_candidates"><code className="connector-page-code">hipeople\_list\_role\_candidates</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve the candidates associated with a specific open job role.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hipeople_get_assessment_report" data-action-label="Get Assessment Report" data-action-scopes="" data-action-auth="Email & Password" data-action-auth-scopes="{&#x22;Email & Password&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Assessment Report</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hipeople_get_assessment_report" aria-label="Copy hipeople_get_assessment_report"><code className="connector-page-code">hipeople\_get\_assessment\_report</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve aggregate assessment statistics for your HiPeople organization.</div>
      </div>
    </div>
  </div>
</div>