Developers
Open Swarmhit
Smart APIRaw API
API referenceLists
GET
/lists

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

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

Response Body

application/json

application/json

curl -X GET "https://example.com/lists"
{  "data": [    {      "id": "string",      "name": "string",      "color": "string",      "leadCount": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "paging": {    "limit": 0,    "offset": 0  }}

List a list's leads GET

**JavaScript SDK:** [`swarmhit.lists.leads.list(listId, params?)`](/smart-api/sdk/methods#lists.leads)

Remove a lead from a list DELETE

**JavaScript SDK:** [`swarmhit.lists.leads.remove(listId, leadId)`](/smart-api/sdk/methods#lists.leads) Takes the lead off the list; the lead itself is kept. If the list is a campaign's own list (the campaign's `listId`), the lead is also removed from that campaign. 404 only for an unknown list: a lead that is not on it still answers 200.