Skip to main content
GET
List campaigns

Authorizations

Authorization
string
header
required

API token in the sk_live_… format.

Query Parameters

page
integer
default:1

Page number, starting at 1. An invalid value is treated as 1.

Required range: x >= 1
perPage
integer
default:20

Number of items per page. The maximum depends on the environment (default 100).

Required range: 1 <= x <= 100

Searches by name.

status
enum<string>

Filters by campaign status. Use all to return every campaign.

Available options:
all,
import:waiting,
import:start,
import:fail_retry,
import:failed,
waiting,
schedule,
processing,
failed,
completed,
canceled,
pause:manual,
pause:automatic,
pause:no_balance,
pause:active_contacts_limit

Response

200 - application/json

OK

data
object[]
meta
object
Example: