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.

consumer_id
string
required

The id you used to create the given consumer

Query Parameters

cashback_rate
number

Filter by cashback_rate

Rate of reward used to calculate cashback amount

default_cashback_rate
number

Filter by default_cashback_rate

is_boosted
boolean

Filter by is_boosted

is_consumed
boolean

Filter by is_consumed

Has the consumer already consumed the coupon of the current offer? If true, yes. If false, no.

loyalty_counter
integer

Filter by loyalty_counter

Purchases made by the Consumer.

loyalty_counter__gt
integer

Filters all loyalty_counter higher than those provided in loyalty_counter__gt.

loyalty_counter__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.

loyalty_frequency
integer

Filter by loyalty_frequency

Number of purchases before the customer gets a reward.

loyalty_frequency__gt
integer

Filters all loyalty_frequency higher than those provided in loyalty_frequency__gt.

loyalty_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

source_transaction
boolean

Filter by source_transaction

If this flag is true, the transaction must come from the default bank of the program to generate a reward

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[]

List of Offer objects

universes
object[]

Universes