List brands with offers visible to this consumer in the program's catalog.

GET

perks

consumers

{consumer_id}

brands

List brands with offers visible to this consumer in the program's catalog.

curl --request GET \
  --url https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-version: <x-api-version>'

import requests

url = "https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands"

headers = {
    "x-api-version": "<x-api-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands', 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-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands",
  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>",
    "x-api-version: <x-api-version>"
  ],
]);

$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-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands"

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

	req.Header.Add("x-api-version", "<x-api-version>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands")
  .header("x-api-version", "<x-api-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands")

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

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

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

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "logo": {
        "url": "https://static.sandbox.paylead.fr/123455.jpeg"
      },
      "max_highlight_level": "HIGHEST",
      "name": "Nike",
      "perks": {
        "cashback": {
          "active_offers_count": 3,
          "max_cashback_rate": "5.00",
          "max_highlight_level": "NORMAL"
        },
        "voucher": {
          "active_offers_count": 2,
          "max_discount_rate": "7.50",
          "max_highlight_level": "NORMAL"
        }
      },
      "max_rate": "7.50",
      "universe": {
        "id": "8f14e45f-ceea-467a-9e1b-2c8f9a0d1e23",
        "name": "Fashion"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 50,
    "total": 137
  }
}

{
  "code": "PL-400-00",
  "errors": [
    {
      "loc": [
        "body",
        "field"
      ],
      "msg": "Field required",
      "type": "missing"
    }
  ],
  "instance": "/path/of/the/request",
  "status": 400,
  "title": "Bad Request"
}

{
  "code": "PL-401-00",
  "status": 401,
  "title": "Unauthorized"
}

{
  "code": "PL-404-02",
  "status": 404,
  "title": "Consumer Not Enrolled"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-api-version

string

default:2.0.0

required

Path Parameters

consumer_id

string

required

Required string length: 2 - 100

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"consumer-12345"

Query Parameters

page

integer

default:1

Required range: x >= 1

per_page

integer

default:50

Required range: 1 <= x <= 1000

sort

enum<string> | null

Sort field, prefixed by - for descending (e.g. -max_highlight_level). max_highlight_level orders on the brand's prominence, max_rate on the rate it headlines — both the values reported at the top level, so the order matches what the payload shows. A brand advertising no rate at all, listed only through a coupon offer, sorts last on max_rate either way. Omit to keep the catalog's brand-name order.

Available options:

max_highlight_level,

-max_highlight_level,

max_rate,

-max_rate

Example:

"-max_highlight_level"

name

string | null

Filter brands by name (case-insensitive partial match).

Example:

"nike"

universe__name

string | null

Filter brands by universe name (case-insensitive partial match).

Example:

"fashion"

perks__cashbacks

boolean | null

When true, only return brands with active cashback offers.

Example:

true

perks__vouchers

boolean | null

When true, only return brands with active voucher offers.

Example:

true

max_highlight_level

string | null

Filter brands on the top-level max_highlight_level, returning exactly the brands reporting it: a brand whose voucher offers peak at HIGHEST reports HIGHEST and is not returned by HIGH, whatever its cashback offers sit at. One of HIGHEST, HIGH or NORMAL — any other value matches no brand and returns an empty listing.

Example:

"HIGHEST"

Response

Successful Response

items

BrandSchema · object[]

required

Show child attributes

meta

PageMeta · object

required

Show child attributes

⌘I

List brands with offers visible to this consumer in the program's catalog.

curl --request GET \
  --url https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-version: <x-api-version>'

import requests

url = "https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands"

headers = {
    "x-api-version": "<x-api-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands', 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-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands",
  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>",
    "x-api-version: <x-api-version>"
  ],
]);

$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-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands"

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

	req.Header.Add("x-api-version", "<x-api-version>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands")
  .header("x-api-version", "<x-api-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/brands")

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

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

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

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "logo": {
        "url": "https://static.sandbox.paylead.fr/123455.jpeg"
      },
      "max_highlight_level": "HIGHEST",
      "name": "Nike",
      "perks": {
        "cashback": {
          "active_offers_count": 3,
          "max_cashback_rate": "5.00",
          "max_highlight_level": "NORMAL"
        },
        "voucher": {
          "active_offers_count": 2,
          "max_discount_rate": "7.50",
          "max_highlight_level": "NORMAL"
        }
      },
      "max_rate": "7.50",
      "universe": {
        "id": "8f14e45f-ceea-467a-9e1b-2c8f9a0d1e23",
        "name": "Fashion"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 50,
    "total": 137
  }
}

{
  "code": "PL-400-00",
  "errors": [
    {
      "loc": [
        "body",
        "field"
      ],
      "msg": "Field required",
      "type": "missing"
    }
  ],
  "instance": "/path/of/the/request",
  "status": 400,
  "title": "Bad Request"
}

{
  "code": "PL-401-00",
  "status": 401,
  "title": "Unauthorized"
}

{
  "code": "PL-404-02",
  "status": 404,
  "title": "Consumer Not Enrolled"
}

Overview

Authentication

Consumers

Perks

Resources

List brands with offers visible to this consumer in the program's catalog.

Authorizations

Headers

Path Parameters

Query Parameters

Response