Getting started

Make your first Swarmhit API request in a few minutes.

The Swarmhit API lets you manage LinkedIn outreach campaigns, leads, lists, sender accounts and your inbox programmatically, and receive real-time events via webhooks.

Base URL

https://app.swarmhit.com/api/v1

Create an API key

Create and revoke keys under Settings → API & Webhooks in the Swarmhit app. A key's full value is shown only once, at creation, so store it securely. Each key is scoped to the workspace it was created in.

Your first request

curl https://app.swarmhit.com/api/v1/campaigns \
  -H "Authorization: Bearer swh_live_xxxxxxxxxxxxxxxxxxxxxxxx"

Pagination

List endpoints accept limit (1-100, default 50) and offset query parameters, and return a paging object alongside data.

Errors

Errors use standard HTTP status codes with a JSON body:

{ "error": { "status": 404, "message": "Campaign not found." } }
StatusMeaning
400Invalid request
401Invalid key
404Missing resource (including a LinkedIn profile that cannot be resolved, code profile_not_found)
409Conflict: a workspace limit, an already pending invitation, or a sender account that needs reconnecting
422An action LinkedIn could not complete on the target profile
429A sender rate limit
500Server error

Next steps

On this page