> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salesive.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List banners

> Retrieve banner creatives for the current storefront with pagination.

## Request

```http theme={null}
GET /banner?page=1&limit=10
x-shop-id: {{shopId}}
```

## Headers

| Header      | Type   | Description                |
| ----------- | ------ | -------------------------- |
| `x-shop-id` | string | Identify the shop context. |

## Query parameters

| Parameter | Type    | Description                                         |
| --------- | ------- | --------------------------------------------------- |
| `page`    | integer | Page number to return (default: `1`).               |
| `limit`   | integer | Maximum number of banners per page (default: `10`). |
| `q`       | string  | Optional search phrase applied to banner titles.    |

## Successful response

```json theme={null}
{
    "status": 200,
    "success": true,
    "message": "Banners found",
    "data": {
        "banners": [],
        "pagination": {
            "total": 0,
            "page": 1,
            "limit": 10,
            "pages": 0,
            "hasNext": false,
            "hasPrev": false,
            "nextPage": null,
            "prevPage": null
        }
    }
}
```

## Error response

```json theme={null}
{
    "status": 500,
    "success": false,
    "message": "You are not authorized to access this resource",
    "data": {}
}
```


## OpenAPI

````yaml GET /banner
openapi: 3.1.0
info:
  title: Salesive Store API
  description: >-
    REST interface for querying products, categories, and merchandising banners
    exposed by Salesive storefronts.
  version: 1.0.0
servers:
  - description: Production
    url: https://store.salesive.com/api/v1
security:
  - BearerAuth: []
    ShopIdHeader: []
paths:
  /banner:
    get:
      summary: List banners
      description: Retrieve banner creatives for the current storefront with pagination.
      parameters:
        - $ref: '#/components/parameters/XShopIdHeader'
        - name: page
          in: query
          description: Page number to return (defaults to 1).
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: limit
          in: query
          description: Maximum number of banners per page (defaults to 10).
          schema:
            type: integer
            minimum: 1
            default: 10
        - name: q
          in: query
          description: Optional search phrase applied to banner titles.
          schema:
            type: string
      responses:
        '200':
          description: Paginated banners response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BannerCollection'
components:
  parameters:
    XShopIdHeader:
      name: x-shop-id
      in: header
      description: >-
        Optional identifier that scopes responses to a specific storefront when
        the referer cannot be inferred.
      required: false
      schema:
        type: string
  schemas:
    BannerCollection:
      type: object
      required:
        - banners
        - total
        - page
        - limit
      properties:
        banners:
          type: array
          items:
            $ref: '#/components/schemas/Banner'
        total:
          type: integer
          minimum: 0
        page:
          type: integer
          minimum: 1
        limit:
          type: integer
          minimum: 1
    Banner:
      type: object
      required:
        - id
        - title
        - image
        - url
        - active
      properties:
        id:
          type: string
          description: Unique banner identifier.
        title:
          type: string
          description: Headline text displayed on the banner.
        description:
          type: string
          description: Optional supporting copy for the banner.
        image:
          type: string
          format: uri
          description: Image asset URL for the banner.
        url:
          type: string
          format: uri
          description: Destination URL when the banner is clicked.
        active:
          type: boolean
          description: Indicates whether the banner is currently active.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT issued by the Salesive Store API for authenticated shoppers.
    ShopIdHeader:
      type: apiKey
      in: header
      name: x-shop-id
      description: >-
        Optional storefront identifier sent as a header to scope responses to a
        specific shop. Try It requests remember this value once provided.

````