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

![SourceWhale](https://stackone-logos.com/api/sourcewhale/filled/svg)

Betav0.2.0[See changelog](https://docs.stackone.com/connectors/sourcewhale/changelog.md)

[6 actions](#actions) · 1 auth method

ATS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/sourcewhale/guides/connector-profile/api-key.md)
>
> Uses a static API key sent in the api-key header. The key is generated in the SourceWhale admin console and requires Adm...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/sourcewhale/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

6 actions

ActionDescription

List Campaigns`sourcewhale_list_campaigns`

List SourceWhale outreach campaigns.

Search Candidates`sourcewhale_search_candidates`

Search for candidates by a key/value pair.

Add Candidates`sourcewhale_add_candidates`

Add one or more candidates to SourceWhale.

Modify Candidate`sourcewhale_modify_candidate`

Modify an existing candidate's details.

List Projects`sourcewhale_list_projects`

List SourceWhale projects.

Get Dashboard Statistics`sourcewhale_get_dashboard_statistics`

Retrieve dashboard statistics for a date range.


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