---
title: "Returns all search banners"
method: GET
path: "/searchbanner"
tags: ["SearchBanners"]
---

# Returns all search banners

`GET /searchbanner`

## Request

- The document declares no server URL.
- Auth: API key in header `TWN-InstanceKey` and API key in header `TWN-Authentication`

## Query parameters

- `limit` integer
- `offset` integer
- `searchTerm` string
- `location` ApiSearchBannerLocation[]
- `status` SearchBannerStatus[]

## Response `200`

OK

- ApiSearchBannerPaging
  - `Total` integer, nullable, required: The total number of records which can be retrieved. Note that this field is not available for all paginated endpoints.
  - `Records` ApiSearchBanner[], required: The retrieved records.
    - `SearchBannerId` integer
    - `Name` string
    - `ActiveFrom` string, date-time
    - `ActiveUntil` string, date-time
    - `TriggerType` 'AllKeywords' | 'SpecificKeywords'
    - `Location` 'ProductsTop' | 'ListTop' | 'ContainerTop'
    - `CategoryId` integer, nullable
    - `Tags` string[]
    - `Items` ApiSearchBannerItem[]
      - `ImageUrl` string
      - `ClickUrl` string, nullable
      - `ClickType` '_self' | '_blank'
      - `State` 'Desktop' | 'Mobile'

---

[API](https://skmtc.dev/tweakwise/apis/app-api.md) - [All operations](https://skmtc.dev/tweakwise/apis/app-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tweakwise/apis/app-api/revisions/dc936bf76941?raw)