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

# Recruitee

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

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

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

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">26 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/recruitee/guides/connector-profile/api-key" icon="https://stackone-logos.com/api/recruitee/filled/svg" horizontal>
        Access requires API token generation from Settings > Apps and plugins > Personal API Tokens
      </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/recruitee/guides/link-account/api-key" icon="https://stackone-logos.com/api/recruitee/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>26 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="recruitee_create_attachment" data-action-label="Create Attachment" 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 Attachment</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="recruitee_create_attachment" aria-label="Copy recruitee_create_attachment"><code className="connector-page-code">recruitee\_create\_attachment</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Upload an attachment from a remote URL</div>
      </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all candidates in the system</div>
      </div>

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

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

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

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

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing candidate's information</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="recruitee_delete_candidate" data-action-label="Delete Candidate" 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>Delete Candidate</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="recruitee_delete_candidate" aria-label="Copy recruitee_delete_candidate"><code className="connector-page-code">recruitee\_delete\_candidate</code></button></div>
        </div>

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

      <div className="connector-meta-library-row" data-action-id="recruitee_update_candidate_cv" data-action-label="Update Candidate CV" 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 Candidate CV</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="recruitee_update_candidate_cv" aria-label="Copy recruitee_update_candidate_cv"><code className="connector-page-code">recruitee\_update\_candidate\_cv</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update a candidate's CV from a remote URL</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="recruitee_list_candidate_notes" data-action-label="List Candidate Notes" 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 Candidate Notes</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="recruitee_list_candidate_notes" aria-label="Copy recruitee_list_candidate_notes"><code className="connector-page-code">recruitee\_list\_candidate\_notes</code></button></div>
        </div>

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

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Search candidates with advanced filtering</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="recruitee_create_candidate_custom_field" data-action-label="Create Candidate Custom Field" 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 Candidate Custom Field</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="recruitee_create_candidate_custom_field" aria-label="Copy recruitee_create_candidate_custom_field"><code className="connector-page-code">recruitee\_create\_candidate\_custom\_field</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Add a custom field to a candidate profile</div>
      </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all departments in the company</div>
      </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Register a new integration partner</div>
      </div>

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

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

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve an integration partner by codename</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="recruitee_delete_partner" data-action-label="Delete Partner" 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>Delete Partner</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="recruitee_delete_partner" aria-label="Copy recruitee_delete_partner"><code className="connector-page-code">recruitee\_delete\_partner</code></button></div>
        </div>

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

      <div className="connector-meta-library-row" data-action-id="recruitee_regenerate_partner_secret" data-action-label="Regenerate Partner Secret" 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>Regenerate Partner Secret</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="recruitee_regenerate_partner_secret" aria-label="Copy recruitee_regenerate_partner_secret"><code className="connector-page-code">recruitee\_regenerate\_partner\_secret</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Regenerate the secret key for an integration partner</div>
      </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all company locations</div>
      </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all job offers in the system</div>
      </div>

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

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

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

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

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

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

      <div className="connector-meta-library-row" data-action-id="recruitee_delete_offer" data-action-label="Delete Offer" 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>Delete Offer</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="recruitee_delete_offer" aria-label="Copy recruitee_delete_offer"><code className="connector-page-code">recruitee\_delete\_offer</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a job offer</div>
      </div>

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

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

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update a partner report status and details</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="recruitee_delete_report" data-action-label="Delete Report" 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>Delete Report</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="recruitee_delete_report" aria-label="Copy recruitee_delete_report"><code className="connector-page-code">recruitee\_delete\_report</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a partner report</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="recruitee_list_candidate_reports" data-action-label="List Candidate Reports" 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 Candidate Reports</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="recruitee_list_candidate_reports" aria-label="Copy recruitee_list_candidate_reports"><code className="connector-page-code">recruitee\_list\_candidate\_reports</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get all reports for a candidate</div>
      </div>
    </div>
  </div>
</div>