List Points Campaigns

get

https://api.yotpo.com/loyalty/v3/stores/{store_id}/campaigns

Returns the store's points drops and points multiplier campaigns, with their status, dates and audience import progress.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

store_id

string

required

Your Yotpo store ID (app key). It must match the store of your X-Yotpo-Token; see Yotpo Authentication.

Query Params

page

integer

≥ 0

Defaults to 0

Zero-based page number, for example 0 for the first page.

page_size

integer

1 to 100

Defaults to 20

Campaigns per page, from 1 to 100. Values over 100 return 400.

status

array of strings

Return only campaigns with these statuses. Repeat the parameter for several, for example status=ACTIVE&status=SCHEDULED. If omitted, every status except DELETED is returned.

status

name

string

length ≤ 255

Case-insensitive part of the campaign name, for example double. Applied before paging, so total_elements counts only matches.

sort

string

enum

Defaults to START_AT

Field to sort by. Campaigns without a value for it come last. Ties are broken by newest id first.

Allowed:

order

string

enum

Defaults to DESC

Sort direction for sort: ASC or DESC.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

text/plain

200The page of campaigns.

400Bad request. An enum parameter such as status or sort has an unknown value (RFC 9457 problem body), or a number is out of range (plain-text body).

401Unauthorized. The X-Yotpo-Token is invalid or expired. Generate a new access token. The body is plain text.

403Forbidden. The X-Yotpo-Token header is missing, or the token belongs to a different store than store_id.

500Unexpected server error. Retry with exponential backoff. If it keeps failing, contact Yotpo support with the request time and store ID.