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/v1Create 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." } }| Status | Meaning |
|---|---|
400 | Invalid request |
401 | Invalid key |
404 | Missing resource (including a LinkedIn profile that cannot be resolved, code profile_not_found) |
409 | Conflict: a workspace limit, an already pending invitation, or a sender account that needs reconnecting |
422 | An action LinkedIn could not complete on the target profile |
429 | A sender rate limit |
500 | Server error |
Next steps
Authentication
API keys and acting on the workspaces in your organization
Campaigns and sequences
Automated outreach with steps, branching and schedules
Leads, lists and imports
Your address book, targeting lists and search imports
Webhooks
Receive real-time events with signed deliveries
LinkedIn safety
Rate limits, pacing and error handling
API Reference
Every endpoint, with schemas and examples