Skip to main content
GET
Get campaigns

Authorizations

x-api-key
string
header
required

Your API key, from the API keys page of the app.

Query Parameters

page
number
default:1

Page number

Required range: x >= 1
Example:

1

limit
number
default:10

Number of records per page

Required range: x >= 1
Example:

10

Search campaign by name

Example:

"My Campaign"

campaignStatus
enum<string>

Filter campaigns by status

Available options:
DRAFT,
ACTIVE,
PAUSED,
STOPPED,
COMPLETED
Example:

"ACTIVE"

Response

Campaign list fetched successfully.

message
string
required
Example:

"Campaigns fetched successfully"

data
object[]
required
pagination
object
required