Getting started

The Smart API lets you run LinkedIn and email outreach programmatically: campaigns whose sequences mix LinkedIn and email steps, leads, lists and LinkedIn search imports, LinkedIn sender accounts, mailboxes (connect existing ones, or buy domains and mailboxes through Swarmhit), the B2B people and company database, one-off LinkedIn actions, your inbox, and the workspaces of an organization. Webhooks deliver events in real time, and an MCP server exposes most of the API to AI agents.

Base URL

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

Create an API key

Create and revoke keys on the Access tokens page in Swarmhit (the API keys card). Keys start with swh_live_. 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. See Authentication for the details.

Your first request

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

Responses are JSON with the result under data; list endpoints add paging. A workspace with no campaigns yet answers:

{ "data": [], "paging": { "limit": 50, "offset": 0 } }

To check which workspace a key acts on, call GET /: it returns that workspace with its plan and seat usage.

Request bodies

Send request bodies as JSON with Content-Type: application/json; without that header the body is ignored. A body can be up to 100 KB: a larger one is refused with 413, and malformed JSON with 400, before the request reaches the API, so those two responses do not carry the JSON error body described below. Adding leads to a list or a campaign accepts up to 1000 leads per request; split a batch that would go over 100 KB.

Pagination

List endpoints accept limit (1-100, default 50) and offset query parameters, and return a paging object alongside data. paging echoes the limit and offset that were applied; most lists carry no total, so request the next page (offset + limit) until one comes back with fewer than limit items. A limit above 100 is treated as 100.

Database searches page with a cursor instead (see Database), and a few short lists, such as the reference data and an organization's workspaces, return everything in one response, without paging.

Errors

Errors use standard HTTP status codes with a JSON body:

{ "error": { "status": 404, "message": "Campaign not found." } }

When present, code is a stable, machine-readable identifier (for example unauthorized, unknown_endpoint or profile_not_found): branch on it rather than on message, whose wording may change. Some errors also carry a details object, such as the limit and its reset time on a sender 429.

Next steps