Offers Consumer Listing

Gets a paginated list of all offers available for the current consumer: generic offers + offers where this consumer is targeted.

For all your logged consumers, you must actually use this route to retrieve the best set of offers dedicated to each consumer.

This list can be filtered by offer types, start date, end date, universe, highlight level…

The list contains all the active offers (status = ACTIVE) and offers to come (status = PUBLISHED).

This list is sorted by default using the conversion probability computed by our internal smart ranking engine.

Pagination of 20 items by default.

GET

offers

Offers Consumer Listing

curl --request GET \
  --url https://api.sandbox.paylead.tech/offers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.paylead.tech/offers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.paylead.tech/offers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.paylead.tech/offers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.paylead.tech/offers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "cashback_rate": 5,
      "highlight_level": "HIGH",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "name": "<string>",
      "status": "<string>",
      "type": "CASHBACK",
      "application_channel": "ONLINE",
      "application_url": "https://www.mybrand.fr",
      "brand": {
        "description": "<string>",
        "id": "e2c32b4b-de61-459b-accf-a75f76247946",
        "legal_terms": "<string>",
        "logo": {
          "content_type": "<string>",
          "id": "e2c32b4b-de61-459b-accf-a75f76247946",
          "links": {
            "download": "<string>",
            "preview": "<string>"
          },
          "name": "<string>",
          "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "name": "<string>",
        "universes": [
          {
            "children": "<array>",
            "id": "e2c32b4b-de61-459b-accf-a75f76247946",
            "name": "<string>",
            "parent_id": "5c5e6d04-9dfc-46b8-9432-7c977f1dca23"
          }
        ]
      },
      "consumed": true,
      "created_at": "2019-01-31T15:16:15.523309+00:00",
      "description": "<string>",
      "end_date": "2017-12-26T23:00:00+00:00",
      "favorite": true,
      "is_activated": true,
      "legal_terms": "<string>",
      "max_amount": 250,
      "max_cashbacks_per_consumer": 123,
      "merchant": {
        "name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "logo": {
          "content_type": "<string>",
          "id": "e2c32b4b-de61-459b-accf-a75f76247946",
          "links": {
            "download": "<string>",
            "preview": "<string>"
          },
          "name": "<string>",
          "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "min_amount": 40,
      "network": "739c5ba7-8831-4664-9ce3-73e9f1e50c09",
      "picture": {
        "content_type": "<string>",
        "id": "e2c32b4b-de61-459b-accf-a75f76247946",
        "links": {
          "download": "<string>",
          "preview": "<string>"
        },
        "name": "<string>",
        "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "program": {
        "id": "<string>",
        "legal_terms": "<string>",
        "name": "<string>"
      },
      "publication_date": "2019-01-01T00:00:00+00:00",
      "reference": "MYBRAND-20180220-001",
      "segments": [
        {
          "id": "e2c32b4b-de61-459b-accf-a75f76247946"
        }
      ],
      "source_transaction": true,
      "start_date": "2018-12-21T00:00:00+00:00",
      "universes": [
        {
          "id": "e2c32b4b-de61-459b-accf-a75f76247946",
          "name": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total": 123
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

application_channel

enum<string>

Offer availability: ONLINE if the offer is online only. OFFLINE if the offer is offline only. BOTH if the offer is online and offline

Available options:

BOTH,

ONLINE,

OFFLINE

brand__name

string

Filter by brand__name

Name of the brand

brand_id

string<uuid>

Filter by brand_id

cashback_rate

number

Filter by cashback_rate

Rate of reward used to calculate cashback amount

created_at

string

Filter by created_at

Filtering on date of creation between -- after -- before --

end_date

string

Filter by end_date

Filtering on end date between -- after -- before --

highlight_level

enum<string>

Enum in: HIGHEST, HIGH, NORMAL. For a contextual display (banner, carousel etc...), this value is set by the program manager on each offer

Available options:

HIGHEST,

HIGH,

NORMAL

name

string

Filter by name

Name of the object

page

integer

the page number

Required range: x >= 1

per_page

integer

the number of elements per page

Required range: 1 <= x <= 100

publication_date

string

Filter by publication_date

Filtering on publication date between -- after -- before --

reference

string

Filter by reference

Unique reference of the offer. Human readable, made out from the concatenation of the brand name + creation date + increment.

sort

enum<string>

Sort by given attribute

Available options:

created_at,

start_date,

end_date,

publication_date,

name,

reference,

type,

application_channel,

brand__name,

brand_id,

highlight_level,

status,

source_transaction,

cashback_rate,

universe,

-created_at,

-start_date,

-end_date,

-publication_date,

-name,

-reference,

-type,

-application_channel,

-brand__name,

-brand_id,

-highlight_level,

-status,

-source_transaction,

-cashback_rate,

-universe

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

start_date

string

Filter by start_date

Filtering on start date between -- after -- before --

status

string

Filter by status

type

enum<string>

Filter by type

Available options:

CASHBACK,

UNIQUE_COUPON,

GENERIC_COUPON

universe

string<uuid>

Filter by universe

Universe of the brand

Response

items

object[]

Option 1
Option 2
Option 3

Show child attributes

meta

object

Show child attributes

⌘I

Offers Consumer Listing

curl --request GET \
  --url https://api.sandbox.paylead.tech/offers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.paylead.tech/offers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.paylead.tech/offers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.paylead.tech/offers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.paylead.tech/offers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "cashback_rate": 5,
      "highlight_level": "HIGH",
      "id": "e2c32b4b-de61-459b-accf-a75f76247946",
      "name": "<string>",
      "status": "<string>",
      "type": "CASHBACK",
      "application_channel": "ONLINE",
      "application_url": "https://www.mybrand.fr",
      "brand": {
        "description": "<string>",
        "id": "e2c32b4b-de61-459b-accf-a75f76247946",
        "legal_terms": "<string>",
        "logo": {
          "content_type": "<string>",
          "id": "e2c32b4b-de61-459b-accf-a75f76247946",
          "links": {
            "download": "<string>",
            "preview": "<string>"
          },
          "name": "<string>",
          "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "name": "<string>",
        "universes": [
          {
            "children": "<array>",
            "id": "e2c32b4b-de61-459b-accf-a75f76247946",
            "name": "<string>",
            "parent_id": "5c5e6d04-9dfc-46b8-9432-7c977f1dca23"
          }
        ]
      },
      "consumed": true,
      "created_at": "2019-01-31T15:16:15.523309+00:00",
      "description": "<string>",
      "end_date": "2017-12-26T23:00:00+00:00",
      "favorite": true,
      "is_activated": true,
      "legal_terms": "<string>",
      "max_amount": 250,
      "max_cashbacks_per_consumer": 123,
      "merchant": {
        "name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "logo": {
          "content_type": "<string>",
          "id": "e2c32b4b-de61-459b-accf-a75f76247946",
          "links": {
            "download": "<string>",
            "preview": "<string>"
          },
          "name": "<string>",
          "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "min_amount": 40,
      "network": "739c5ba7-8831-4664-9ce3-73e9f1e50c09",
      "picture": {
        "content_type": "<string>",
        "id": "e2c32b4b-de61-459b-accf-a75f76247946",
        "links": {
          "download": "<string>",
          "preview": "<string>"
        },
        "name": "<string>",
        "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "program": {
        "id": "<string>",
        "legal_terms": "<string>",
        "name": "<string>"
      },
      "publication_date": "2019-01-01T00:00:00+00:00",
      "reference": "MYBRAND-20180220-001",
      "segments": [
        {
          "id": "e2c32b4b-de61-459b-accf-a75f76247946"
        }
      ],
      "source_transaction": true,
      "start_date": "2018-12-21T00:00:00+00:00",
      "universes": [
        {
          "id": "e2c32b4b-de61-459b-accf-a75f76247946",
          "name": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total": 123
  }
}

Banks

Bank Synchronization

Brands

User

Accounts

Payment Account

Reward

Metrics

Offers

Offer

Personal Finance Manager

Pools

Policies

Authentication

Store

Segment

Files

Universe

Offers Consumer Listing

Authorizations

Query Parameters

Response