---
title: "Returns a search banner"
method: GET
path: "/searchbanner/{searchBannerId}"
tags: ["SearchBanners"]
---

# Returns a search banner

`GET /searchbanner/{searchBannerId}`

## Request

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

## Path parameters

- `searchBannerId` integer, required

## Response `200`

OK

- ApiSearchBanner
  - `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'

## Other responses

- `404`: Not Found

---

[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)