Developers
Open Swarmhit
Smart APIRaw API
API referenceAccounts
GET
/accounts

JavaScript SDK: swarmhit.accounts.list(params?)

Connected LinkedIn accounts, with their health, daily limits and usage, pause state (paused / pausedReason), invite-limit cooldown (cooldownUntil) and InMail credit balance (inmailCredits). Credentials are never returned.

With archived=true, the archived accounts instead, newest first: each is an ArchivedAccount (status: archived, archivedAt, campaignIds). Bring one back with POST /accounts/{id}/restore. Archived accounts are kept for 90 days, then deleted permanently.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Query Parameters

limit?integer

Page size, 1–100.

Range1 <= value <= 100
Default50
offset?integer

Number of records to skip.

Range0 <= value
Default0
archived?boolean

true lists the archived accounts instead of the connected ones.

Defaultfalse

Response Body

application/json

application/json

curl -X GET "https://example.com/accounts"
{  "data": [    {      "id": "string",      "label": "string",      "senderId": "string",      "fullName": "string",      "firstName": "string",      "lastName": "string",      "headline": "string",      "publicIdentifier": "string",      "profileUrl": "string",      "profilePicture": "string",      "connectionMethod": "cookie",      "connectedVia": "app",      "hostedLinkId": "string",      "status": "active",      "connectionStatus": "string",      "isVerified": true,      "isPremium": true,      "linkedinPlan": "classic",      "error": "string",      "limits": {},      "usage": {},      "paused": true,      "pausedReason": "user",      "pausedAt": "2019-08-24T14:15:22Z",      "cooldownUntil": "2019-08-24T14:15:22Z",      "cooldownReason": "invite_daily_limit",      "checkpoint": {        "type": "2FA",        "input": "code",        "requestedAt": "2019-08-24T14:15:22Z",        "expiresAt": "2019-08-24T14:15:22Z",        "expired": true,        "canResend": true,        "canTryAnotherWay": true,        "liveView": true      },      "inmailCredits": {        "balance": 0,        "syncedAt": "2019-08-24T14:15:22Z"      },      "ssi": {        "score": 0,        "brand": 0,        "people": 0,        "insights": 0,        "relationships": 0,        "industryTop": 0,        "networkTop": 0,        "industryAverage": 0,        "networkAverage": 0,        "industryName": "string",        "unavailable": true,        "syncedAt": "2019-08-24T14:15:22Z"      },      "country": "string",      "stoppedReason": "proxy_drift",      "connection": {        "country": "string",        "isp": "string",        "changedAt": "2019-08-24T14:15:22Z"      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "paging": {    "limit": 0,    "offset": 0  }}

Get a hosted connect link GET

**JavaScript SDK:** [`swarmhit.accounts.hostedLinks.get(hostedLinkId)`](/smart-api/sdk/methods#accounts.hostedLinks) What became of a link: `pending` while it is still open (a failed sign-in attempt leaves it open), `connected` once a sender came out of it (`accountId` names it), `failed` when the person cancelled on the page (`error.code: cancelled`), `expired` once its window closed. Never returns the link URL or its token.

Pause a sender POST

**JavaScript SDK:** [`swarmhit.accounts.pause(accountId)`](/smart-api/sdk/methods#accounts) Pause the sender: campaigns stop acting from it and direct actions are rejected with 409 `code: sender_paused` until it is resumed. Its campaign leads stay assigned; use `POST /campaigns/{id}/senders/{accountId}/rebalance` to move the not-yet-contacted ones onto other senders. Pausing an already-paused sender is a no-op and still returns the account. Emits an `account.paused` webhook.