Get Campaigns

Gets campaigns that are both active and eligible for the customer. Retrieve campaigns by passing in either the internal or external ID for the customer.

Sequence Diagram

See the overall flow for this task below.

CUSTOMER CUSTOMER CLIENT MIDDLEWARE CLIENT MIDDLEWARE SESSIONM SESSIONM GET CAMPAIGNS Navigate to active campaigns offering bonus Get eligible campaigns, filtering on creatives and behaviors Return eligible campaigns Display campaigns

API Endpoints & Constraints

GET /priv/v2/apps/:api_key/users/:user_id/campaigns
GET /priv/v2/apps/:api_key/external/users/:external_id/campaigns

The following filters can be specified for these endpoints:

  • section[] for controlling which sections appear.

  • creatives[] for controlling which creatives appear.

  • filters[] for controlling which campaigns appear.

For more information, see the "Endpoint Parameters" section of the associated API reference doc.