campaigns

Campaign vouchers

List all campaign vouchers. This API lists all vouchers associated to the campaign.

Requires scope:

campaigns.voucher.list

get/v1/campaign/{campaign}/vouchers

Request

  • Base URL: https://api.playable.com
  • URL: https://api.playable.com/v1/campaign/{campaign}/vouchers
  • Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: campaigns.voucher.list)

Path parameters

campaigninteger required

Campaign id

Query parameters

with'registration' | 'prize'

Comma separated list of extra fields to include about the vouchers.

pageinteger

Response

Lists all campaign vouchers available in the system

selfstring

Example response

{
  "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.