Get available banners. - Lobyco Help center

Get available banners.

curl --request GET \
  --url https://{host}/banner/v2/banners \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://{host}/banner/v2/banners', 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://{host}/banner/v2/banners",
  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: <api-key>"
  ],
]);

$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://{host}/banner/v2/banners"

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

	req.Header.Add("Authorization", "<api-key>")

	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://{host}/banner/v2/banners")

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

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

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

{
  "banners": [
    {
      "id": "<string>",
      "name": "<string>",
      "analyticsId": "<string>",
      "bannerType": "OfferByChain",
      "chainIds": [
        "<string>"
      ],
      "storeIds": [
        "<string>"
      ],
      "actionUrl": "<string>",
      "useWebWrapper": true,
      "contentType": "Image",
      "content": {}
    }
  ]
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

GET

/

v2

/

banners

Get available banners.

curl --request GET \
  --url https://{host}/banner/v2/banners \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://{host}/banner/v2/banners', 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://{host}/banner/v2/banners",
  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: <api-key>"
  ],
]);

$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://{host}/banner/v2/banners"

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

	req.Header.Add("Authorization", "<api-key>")

	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://{host}/banner/v2/banners")

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

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

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

{
  "banners": [
    {
      "id": "<string>",
      "name": "<string>",
      "analyticsId": "<string>",
      "bannerType": "OfferByChain",
      "chainIds": [
        "<string>"
      ],
      "storeIds": [
        "<string>"
      ],
      "actionUrl": "<string>",
      "useWebWrapper": true,
      "contentType": "Image",
      "content": {}
    }
  ]
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

Authorizations

Authorization

string

header

required

Opaque Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Query Parameters

memberId

string

The unique identifier of the member for whom banners should be retrieved.

BannerTypes

enum<string>[]

Optional list of banner types to filter by.

Available options:

OfferByChain,

Partner,

Hero,

CoopDk,

Receipt

ChainId

string

Optional chain identifier to filter banners for a specific chain.

storeId

string[]

Optional list of store identifiers to filter banners for specific stores.

Response

Success

banners

object[]

Collection of available banners returned in the response.

Show child attributes

Last modified on August 10, 2026

⌘I