Skip to content

List campaigns

GET
/campaigns

Returns list of campaigns

Successfully retrieved campaigns

object
meta
object
pagination
Pagination section

Contains page and count information for lists

object
count

Number of items returned in this response

integer
totalCount

Total number of items in collection

integer
page

Current page

integer
totalPages

Total number of pages in collection

integer
data
Array<object>
Campaign

Object representing a campaign

object
id

Internal campaign ID

integer
name

Campaign name

string
createdAt

Date of campaign creation

date
updatedAt

Date of last campaign update

date
type

Type of campaign (display/video etc)

string
shareURL

Complete share campaign URL

string
adspecId

Default adspec ID for campaign

integer
userId

User ID of user that created the campaign

integer

401 Authentication failed

401 Authentication failed response

Unable to authenticate user

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string

404 Not found

404 Not found response

Requested resource or underlying resource was not found

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string

422 Unprocessable entity

422 Unprocessable entity

There is something wrong with the content of the request, typically missing or improperly formatted fields

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string