Skip to main content
GET
List Campaigns

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

tenantId
string
required

Tenant ID

Pattern: ^[1-9]\d*$
query
string

Search filter by campaign name

paginated
string

Enable pagination (1 = yes, 0 = no)

page
string

Page number

Pattern: ^[1-9]\d*$
recordsPerPage
string

Number of records per page

Pattern: ^[1-9]\d*$

Response

200 - application/json

Campaign list

records
object[]
required
page
number
required
maxPage
number
required
totalRecords
number
required