Skip to main content
GET
List the token owner's campaigns with headline analytics

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Query Parameters

limit
integer
default:25

Page size, 1-100 (default 25).

Required range: 1 <= x <= 100
pageNum
integer
default:1

1-based page number (default 1).

Required range: x >= 1

Free text matched case-insensitively against the campaign name only (1-200 characters); any string is accepted. The value reaches the store as a regular expression rather than a literal, so metacharacters such as ( ) [ ] + * ? | are interpreted — send plain words, or escape them. A term that matches no campaign returns an empty page, not an error.

Required string length: 1 - 200
type
enum<string>

Restrict to ai-generated or manual campaigns — the same values a campaign's type reports.

Available options:
ai-generated,
manual
status
enum<string>

Restrict to one status: initializing (draft, not yet approved), active (approved and sending), stopped (stopped via /stop or deleted), paused_manual (paused by the app), initialization_failed (AI initialization failed; see initializationError).

Available options:
active,
initializing,
initialization_failed,
stopped,
paused_manual
folderId
string

Return only campaigns filed in this sequences folder (see GET /business/folders).

Response

Success

campaigns
object[]
required
pagination
object
required