Skip to Content
Alienmail Docs
Campaigns

List campaigns

GET
/campaigns

The campaigns of your workspace, newest first. Archived campaigns are included; deleted ones are not.

Requires the CAMPAIGN_READ permission.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key of your workspace, from Workspace settings, Integrations. Each key has a role, and the role decides which endpoints it may call.

Query Parameters

status?string

Only campaigns with this status.

Value in"draft""active""paused""completed""archived"
search?string

Only campaigns whose name contains this text.

limit?integer

Items per page, 1 to 100. Default 25. A number outside that range is rounded to the nearest limit (0 is 1, 500 is 100) and a fraction rounded down; anything that is not a number is the default.

Range1 <= value <= 100
Default25
cursor?string

The nextCursor of the previous page. Anything else returns 400.

Response Body

A page of campaigns.

application/json
  1. response
data*array<>
nextCursor*|

Pass as cursor to get the next page. null on the last page.

Example Request
curl -X GET 'https://app.alienmail.io/api/v1/campaigns'
Example Response
{  "data": [    {      "id": 42,      "name": "Q1 outreach",      "status": "active",      "leadCount": 180,      "sentCount": 412,      "lastSentAt": "2026-11-13T09:30:00.000Z",      "createdAt": "2026-11-13T09:30:00.000Z",      "updatedAt": "2026-11-13T09:30:00.000Z"    }  ],  "nextCursor": null}