campaigns

Campaigns list

This API lists all campaigns.

Requires scope:

campaigns.list

get/v1/campaigns

Request

Base URL: https://api.playable.com
URL: https://api.playable.com/v1/campaigns
Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: campaigns.list)

Query parameters

sortstring

Comma separated list which allows for multi-sorting. Available fields are: name, created_on. Available options are: asc, desc.

filter_templatestring

Filter for campaign templates.

filter_namestring

Filter for specific campaign by name.

filter_typestring

Filter for specific campaign type by alias.

filter_display'active' | 'inactive'

Filter for active or inactive campaigns.

withstring[]

Comma separated list of extra fields to include about the campaigns. Available options are: registrations, sessions, is_instant_win, has_data_wiped, integrations, sections, sections.form_fields, bulk_prizes & sections.sessions.

pageinteger

Response

Lists all campaigns available in the system

Example response

{
  "data": [
    {
      "timezone": "Europe/Copenhagen"
    }
  ],
  "links": [
    {
      "first": "https://api.playable.com/v1/route?page=1",
      "last": "https://api.playable.com/v1/route?page=14",
      "prev": "https://api.playable.com/v1/route?page=13",
      "next": "https://api.playable.com/v1/route?page=2"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.