List Campaigns

GET 
/campaigns

List Campaigns

Request

Query Parameters

limit number

Number of items to return

offset number

Number of items to skip

filter.id string

Id

filter.tags string

Tags

filter.name string

Name

filter.description string

Description

filter.startDate string

Start Date

filter.endDate string

End Date

filter.bookings number

Bookings

filter.totalSpend number

Total Spend

filter.createdAt string

Created At

filter.updatedAt string

Updated At

filter.deletedAt string

Deleted At

filter.deleted string

Deleted

filter.createdBy string

Created By

filter.updatedBy string

Updated By

filter.deletedBy string

Deleted By

filter.ownerType string

Owner Type

filter.ownerId string

Owner

include string[]

Possible values: [id, tags, name, description, startDate, endDate, bookings, totalSpend, createdAt, updatedAt, deletedAt, deleted, createdBy, updatedBy, deletedBy, ownerType, ownerId]

Responses

200

List of Campaigns

application/json

Schema

Schema

• Array [

tags string

Tags

name string

Name

description string

Description

startDate string

Start Date

endDate string

End Date

bookings number

Bookings

totalSpend number

Total Spend

ownerType string

Owner Type

ownerId string

Owner

id string

Id

createdAt string

Created At

updatedAt string

Updated At

deletedAt string

Deleted At

deleted string

Deleted

createdBy string

Created By

updatedBy string

Updated By

deletedBy string

Deleted By

• ]

Example (from schema)

[
  {
    "tags": "string",
    "name": "string",
    "description": "string",
    "startDate": "string",
    "endDate": "string",
    "bookings": 0,
    "totalSpend": 0,
    "ownerType": "string",
    "ownerId": "string",
    "id": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": "string",
    "deleted": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "deletedBy": "string"
  }
]

Loading...