canonical: https://jentic.com/apis/sourcewhale.app/sourcewhale

# Sourcewhale App SourceWhale API

SourceWhale public API for managing campaigns, candidates, projects, and statistics. The API exposes 6 endpoints secured with apiKey authentication.

## For AI agents

Programmatically list campaigns, add new candidates. Covers 6 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for marketing only.

## Capabilities

- List campaigns
- Add new candidates
- Modify candidate data
- Search candidates
- Get dashboard statistics

## Use cases

### Marketing Operations

Use the SourceWhale API to perform marketing operations programmatically. The API provides 6 endpoints covering core functionality including list campaigns, add new candidates, modify candidate data.

Example prompt: Call GET `/v1/campaigns/list` to list campaigns

### Automated Campaigns Management

Automate campaigns operations by combining multiple SourceWhale API endpoints. Agents can add new candidates and then modify candidate data in a single workflow.

Example prompt: Call POST `/v1/candidates/add` to add new candidates, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SourceWhale API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'list campaigns', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v1/campaigns/list` | List campaigns |
| POST | `/v1/candidates/add` | Add new candidates |
| POST | `/v1/candidates/modify` | Modify candidate data |
| GET | `/v1/candidates/search` | Search candidates |
| GET | `/v1/projects/list` | List projects |
| GET | `/v1/statistics/dashboard` | Get dashboard statistics |

## Key resources

- **Campaigns** — Operations related to Campaigns
- **Candidates** — Operations related to Candidates
- **Projects** — Operations related to Projects
- **Statistics** — Operations related to Statistics

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 65 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 90 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/sourcewhale.app/sourcewhale/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the SourceWhale API by hand means passing its api-key header on every call, pointing at the sourcewhale.app/public-api host, and handling paging and retries across its campaign and candidate calls yourself. Through Jentic you install once, import the SourceWhale API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** The SourceWhale API carries its candidate and campaign targets in the request body and query parameters rather than resource ids in the URL path, so limit the agent to the operations it needs, such as listing campaigns or searching candidates. You choose the operations it may call, so write operations like adding or modifying a candidate are not included unless you add them.
- **Credential handling:** Your SourceWhale API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list campaigns' or 'search candidates', and Jentic returns the matching SourceWhale API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mailchimp** — Alternative marketing API
- **Hubspot** — Alternative marketing API

## FAQ

### What authentication does the SourceWhale API use?

The SourceWhale API uses an API key passed in the `api-key` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I list campaigns with the SourceWhale API?

Yes. Use the GET `/v1/campaigns/list` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SourceWhale API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I list campaigns through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list campaigns'. Jentic returns the matching SourceWhale API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the SourceWhale API have?

The SourceWhale API exposes 6 endpoints covering campaigns, candidates, projects operations.

### Can I limit what my agent is allowed to do with the SourceWhale API?

Yes. Because Jentic One is self-hosted, you decide which SourceWhale operations your agent may call, so you can grant only read actions like GET `/v1/campaigns/list`, GET `/v1/candidates/search`, GET `/v1/projects/list`, and GET `/v1/statistics/dashboard.` Write operations such as POST `/v1/candidates/add` and POST `/v1/candidates/modify` are excluded unless you explicitly add them. Since SourceWhale carries its candidate and campaign targets in the request body and query parameters rather than in the URL path, your scoping rules operate at the operation level, and your API key stays in your own instance and is injected only when a permitted call runs.