Skip to main content
GET
Gets consumers offer for a brand.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
string<uuid>
required

Unique ID of the brand on PayLead system.

Query Parameters

frequency
integer

Filter by frequency

Number of purchases before the customer gets a reward.

frequency__gt
integer

Filters all frequency higher than those provided in frequency__gt.

frequency__isnull
boolean

Filters all offers depending on whether they are a loyalty_offer or not. If "true", retrieves all the Offers that are not of loyalty type. If "false", retrieves all the Offers of loyalty type.

offer__id
string<uuid>

Filter by offer__id

Unique UUID of the offer

offer__name
string

Filter by offer__name

Name of the offer

sort
enum<string>

Sort by given attribute

Available options:
offer__id,
offer__name,
frequency,
-offer__id,
-offer__name,
-frequency

Response

OK

name
string
required
read-only

Name of the object

description
string
read-only

description

id
string<uuid>
read-only

Unique ID of the object.

Example:

"e2c32b4b-de61-459b-accf-a75f76247946"

offers
object[]
read-only

List of the brand's offers. Since 1.1.12, each offer is described by the schema of its type.

Cashback-only fields (cashback_rate, source_transaction, max_amount, min_amount, max_cashbacks_per_consumer, max_limit_transaction_amount) are documented on cashback offers (CASHBACK, LBS_CASHBACK) only. Up to 1.1.11, the single Offer schema listed them for every offer type, but they were never returned on voucher, coupon or affiliation offers: nothing changes in the responses for them.

Voucher, coupon and affiliation offers keep frequency (always null) and capping_period (always NO_RESET), and get their own fields: the vouchers' amounts and discount rate, the coupons' discount, the affiliation offers' reward rates and commissions.

universes
object[]
read-only

Universes