Skip to main content
GET
/
banner
List banners
curl --request GET \
  --url https://store.salesive.com/api/v1/banner \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'
{
  "banners": [
    {
      "id": "<string>",
      "title": "<string>",
      "image": "<string>",
      "url": "<string>",
      "active": true,
      "description": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 1,
  "page": 2,
  "limit": 2
}

​
Request

GET /banner?page=1&limit=10&q={search-term}

​
Query parameters

ParameterTypeDescription
pageintegerPage number to return (default 1).
limitintegerMaximum number of banners per page (default 10).
qstringOptional search phrase applied to banner titles.

​
200 response

{
    "banners": [
        {
            "id": "68c4f1cab50803b7b1310c60",
            "title": "Holiday Sale",
            "image": "https://cdn.salesive.com/banners/holiday-sale.png",
            "url": "https://salesive.com/holiday",
            "active": true
        }
    ],
    "total": 24,
    "page": 1,
    "limit": 10
}

Authorizations

​
Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

​
x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

​
x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Query Parameters

​
page
integer
default:1

Page number to return (defaults to 1).

Required range: x >= 1
​
limit
integer
default:10

Maximum number of banners per page (defaults to 10).

Required range: x >= 1
​
q
string

Optional search phrase applied to banner titles.

Response

200 - application/json

Paginated banners response.

​
banners
object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
limit
integer
required
Required range: x >= 1