campaigns

Campaign registrations

This API list registrations associated with a campaign.

Requires scope:

campaigns.registrations.list

get/v1/campaign/{campaign}/registrations

Request

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

Path parameters

campaigninteger required

Campaign id

Query parameters

with'prize' | 'leadscore'

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

Available options are: prize & leadscore

per_pageinteger

Registrations per page. Default is 10 & max is 500.

filter_date_fromstring date

Date format: Y-m-d or ISO-8601. Example: 2021-01-01T08:00:00%2B00:00

filter_date_tostring date

Date format: Y-m-d or ISO-8601. Example: 2021-01-01T08:00:00%2B00:00

filter_emailstring email

Filter registrations by email address.

filter_winner0 | 1

Filter by winner status. Pass 1 for winners, 0 for non-winners.

filter_bulk_prize_woninteger

Filter registrations that won a specific bulk prize. Pass the bulk prize ID.

pageinteger

Response

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.