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

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

sort
enum<string>

Sort by given attribute

Available options:
offer__id,
offer__name,
loyalty_frequency,
-offer__id,
-offer__name,
-loyalty_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 Offer objects

universes
object[]
read-only

Universes