List ways to earn (storefront)

Returns your live earning campaigns, for a "ways to earn" section. It needs only your public Loyalty GUID, so you can call it from the browser. The server-side equivalent is Get Active Campaigns, which needs your API key and can also return a customer's progress.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Your Loyalty GUID. Find it in the Loyalty admin under Settings > General. It is public and safe to use in the browser.

campaign_types[]
array of strings

Return only these campaign types. Repeat the parameter for each type, for example campaign_types[]=PointsForPurchasesCampaign&campaign_types[]=ReferralCampaign. A plain campaign_types=... value returns 422.

campaign_types[]
integer

A Yotpo Loyalty customer ID. When campaigns are targeted to customer segments, returns only the campaigns this customer's segments can see. Ignored otherwise.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json