Skip to main content
GET
List Promotions
Promotions is enabled per organizationThis endpoint works only after Yuno enables Promotions for your organization. Until then it answers 404 PROMOTION_NOT_FOUND. Ask your Technical Account Manager or Key Account Manager. See Promotions.
The list belongs to the account in the X-Account-Code header. To see the promotions of several accounts, call once per account. The list holds every promotion of the account: the CODE promotions you create with the API and the AUTOMATIC ones. Check redemption.mode to tell them apart.

Pages

Results come newest first, by created_at. A page holds up to limit promotions: 20 by default, 1 to 100 allowed. When more promotions exist, next_cursor is a string: pass it as cursor to read the next page. On the last page next_cursor is null. The cursor is opaque. A cursor that is not valid answers 400 INVALID_REQUEST with the message cursor: FORMAT. Use status to keep one status: SCHEDULED, ACTIVE, EXPIRED or DISABLED. It accepts any case of the ASCII letters. Surrounding spaces are ignored, and a value of only spaces is read as no filter. Any other value, including one with a non-ASCII look-alike letter, answers 400 INVALID_REQUEST with status: UNKNOWN. Any other query parameter is ignored.

Authorizations

public-api-key
string
header
default:<Your public-api-key>
required
private-secret-key
string
header
default:<Your private-secret-key>
required

Headers

X-Account-Code
string
required

The account_id found in your Yuno Dashboard (UUID). Required. A promotion belongs to one account, and this header names it. Omitting it returns 400 INVALID_PARAMETERS ("x-account-code header is required.").

Query Parameters

status
enum<string>

Filter by status. It accepts any case of the ASCII letters. Surrounding spaces are ignored. Any other value, including one with a non-ASCII look-alike letter, returns 400 INVALID_REQUEST with the message status: UNKNOWN.

Available options:
SCHEDULED,
ACTIVE,
EXPIRED,
DISABLED
limit
integer
default:20

Page size, 1 to 100. The default is 20. A value outside the range returns 400 INVALID_REQUEST with the message limit: RANGE, and one that is not a whole number of up to 3 digits limit: FORMAT.

Required range: 1 <= x <= 100
cursor
string

Opaque. The next_cursor of the previous page. A cursor that is not valid returns 400 INVALID_REQUEST with the message cursor: FORMAT.

Response

  1. One page of promotions.
data
object[]

One page of promotions, newest first. Empty for an empty page.

next_cursor
string | null

Pass it as cursor to read the next page. null on the last page.