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

# SourceWhale

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

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/sourcewhale/filled/svg" alt="SourceWhale" 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>v0.1.0</span></div>
    <div><a href="/connectors/sourcewhale/changelog">See changelog</a></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">6 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/sourcewhale/guides/connector-profile/api-key" icon="https://stackone-logos.com/api/sourcewhale/filled/svg" horizontal>
        Uses a static API key sent in the api-key header. The key is generated in the SourceWhale admin console and requires Adm...
      </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/sourcewhale/guides/link-account/api-key" icon="https://stackone-logos.com/api/sourcewhale/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>6 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="sourcewhale_list_campaigns" data-action-label="List Campaigns" 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 Campaigns</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="sourcewhale_list_campaigns" aria-label="Copy sourcewhale_list_campaigns"><code className="connector-page-code">sourcewhale\_list\_campaigns</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List SourceWhale outreach campaigns.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="sourcewhale_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="sourcewhale_search_candidates" aria-label="Copy sourcewhale_search_candidates"><code className="connector-page-code">sourcewhale\_search\_candidates</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Search for candidates by a key/value pair.</div>
      </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Add one or more candidates to SourceWhale.</div>
      </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Modify an existing candidate's details.</div>
      </div>

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

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List SourceWhale projects.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="sourcewhale_get_dashboard_statistics" data-action-label="Get Dashboard Statistics" 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 Dashboard Statistics</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="sourcewhale_get_dashboard_statistics" aria-label="Copy sourcewhale_get_dashboard_statistics"><code className="connector-page-code">sourcewhale\_get\_dashboard\_statistics</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve dashboard statistics for a date range.</div>
      </div>
    </div>
  </div>
</div>