Skip to content
Tilecast Docs

listCampaigns

GET
/api/v1/campaigns
curl --request GET \
  --url https://example.com/api/v1/campaigns

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
search
string
page
integer
>= 1
pageSize
integer
>= 1 <= 100

Responses

Section titled “ Responses ”

200

Section titled “200”

Campaign library

Media typeapplication/json
object
data
required
object
items
required
Array<object>
object
id
required
string format: uuid
name
required
string
description
required
string
ownerId
string format: uuid
timezone
required
string
campaignStart
string format: date-time
campaignEnd
string format: date-time
destinations
required
Array<object>
object
type
required
string
Allowed values: screen group
id
required
string format: uuid
draft
required
object
name
required
string
>= 1 characters <= 180 characters
description
required
string
<= 2000 characters
ownerId
string format: uuid
timezone
required
string
>= 1 characters <= 64 characters
campaignStart
string format: date-time
campaignEnd
string format: date-time
destinations
required
Array<object>
object
type
required
string
Allowed values: screen group
id
required
string format: uuid
blocks
required
Array<object>
object
id
required
string format: uuid
name
required
string
<= 180 characters
contentType
required
string
Allowed values: playlist layout
contentId
required
string format: uuid
contentRevision
integer format: int64
>= 1
priority
required
integer
type
required
string
Allowed values: one_time weekly
timezone
required
string
>= 1 characters <= 64 characters
startDate
string format: date
endDate
string format: date
oneTimeStart
string format: date-time
oneTimeEnd
string format: date-time
dailyStart
string
/^\d{2}:\d{2}$/
dailyEnd
string
/^\d{2}:\d{2}$/
daysOfWeek
Array<integer>
enabled
required
boolean
draftRevision
required
integer format: int64
>= 1
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
total
required
integer
page
required
integer
pageSize
required
integer
Example
{
  "data": {
    "items": [
      {
        "destinations": [
          {
            "type": "screen"
          }
        ],
        "draft": {
          "destinations": [
            {
              "type": "screen"
            }
          ],
          "blocks": [
            {
              "contentType": "playlist",
              "type": "one_time"
            }
          ]
        }
      }
    ]
  }
}