PlunkPlunk
API ReferenceCampaigns

List campaigns

Get a paginated list of email campaigns

GET
/campaigns

Authorization

ApiKeyAuth

AuthorizationBearer <token>

API Key authentication. Secret keys (sk_*) are required for all endpoints except /v1/track. Public keys (pk_*) only work with the /v1/track endpoint for client-side event tracking. The project is automatically derived from the key.

In: header

Query Parameters

limit?integer

Maximum items per page

Default20
Range1 <= value <= 100
cursor?string

Pagination cursor

status?string
Value in"DRAFT" | "SCHEDULED" | "SENDING" | "SENT"

Response Body

application/json

curl -X GET "https://plunk-api.tophunting.ai/campaigns"
{
  "campaigns": [
    {
      "id": "string",
      "name": "string",
      "subject": "string",
      "type": "ALL",
      "status": "DRAFT",
      "scheduledAt": "2019-08-24T14:15:22Z"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "total": 0,
  "totalPages": 0
}