Skip to main content
GET
List banners

Request

Headers

Query parameters

Successful response

Error response

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