Skip to main content

SourceWhale REST API

Learn how to use SourceWhale REST API - authentication, API keys, available endpoints, rate limits, and paginated results

⚠️ Our API V2 is in active expansion. SourceWhale adds new endpoints weekly, and endpoints can change without further notice.

Overview

SourceWhale's REST API gives you direct access to your data. It exposes key elements of your CRM & ATS: People, Projects, Companies, Activities, Notes, To-dos, Calls and Meetings transcripts, and more.

The full endpoint reference can be accessed here:

https://public.sourcewhale.app/v2/docs

Common Use Cases

  • Build custom reporting and dashboards using SourceWhale CRM & ATS data

  • Pull data out of SourceWhale CRM & ATS

API v2 currently provides read and query access. It does not provide public endpoints for creating or updating SourceWhale records.

Authentication & API Key

Place the API key in the API-Key header on every request. API keys are specific to a SourceWhale user and team.

  • Base URL: https://public.sourcewhale.app/v2

  • To access REST API endpoints, API key is required

How to Generate API Key

  • API Key is required to access REST API endpoints, these are user specific.

  • Each key is bound to both the workspace and the user who created it. Every action performed with the key is attributed to that user; there is no way to pass a different actor in the request. This protects audit trails and prevents impersonation.

  • If your integration acts on behalf of multiple users, each user needs their own API key

  1. Navigate to Profile page

  2. Scroll to the bottom of the page where you can find API V2 Key section

  3. Click Generate API Key and copy the value

  4. To disable your API Key, click Revoke Key button

Rate limits and pagination

  • API endpoints allows 600 requests per minute for each API user.

  • When the limit is exceeded, the API returns HTTP 429 and the Retry-After: 60

  • Use the Retry-After value before sending more requests.

json
{
  "error": {
    "message": "Rate limit exceeded"
  }
}

​

Search endpoints and paginated list endpoints use cursor-based pagination.

  • The default limit is 25.

  • The accepted limit range is 1 to 100.

  • List requests pass limit and cursor as query parameters.

  • Search requests pass limit and cursor in the JSON body.

  • Pass pagination.nextCursor unchanged into the next request's cursor parameter.

  • Stop when nextCursor is null.

  • API v2 does not use page-number pagination.

FAQ

  1. Does API v2 have a webhook, and what does it cover?

    Webhook is available in our API v1, v2 doesn't provide a general webhook or event-subscription endpoint. The separate API v1 Zapier subscriptions send a POST containing a candidate object for candidateCreated and candidateUpdated events. You can restrict updates to selected candidate fields. These subscriptions only cover candidate creation and update events.

  2. Can I reuse my API v1 key with API v2?

    No. API v2 requires its own user-specific key in the API-Key header. An API v1 key does not authenticate API v2 requests.
    ​

  3. Do I need a connected CRM to use API v2?

    No. API keys are tied to a SourceWhale user and team, so you can connect reporting tools, data warehouses, automation platforms or custom applications without a connected CRM integration.

Stuck or need some help? Click on the chat icon at the bottom right-hand corner to connect with our support team!

Related Articles
Did this answer your question?