---
title: "Get banner configuration"
method: GET
path: "/sites/{id}/banner"
tags: ["Banner"]
---

# Get banner configuration

`GET /sites/{id}/banner`

## Request

- Base URL: `http://localhost:3001/api/v1`
- URL: `http://localhost:3001/api/v1/sites/{id}/banner`
- Auth: HTTP bearer

Returns the banner configuration for a site.

## Path parameters

- `id` string, uuid, required: Site ID

## Response `200`

Banner configuration

- object
  - `id` string, uuid, required
  - `siteId` string, uuid, required
  - `template` 'floating' | 'wide_bar' | 'modal', required
  - `position` 'bottom_left' | 'bottom_right' | 'top_left' | 'top_right' | 'bottom' | 'top' | 'center', required
  - `colors` object, required
  - `textOverrides` object, required
  - `logoUrl` string, nullable, required
  - `privacyPolicyUrl` string, nullable, required
  - `defaultBehavior` 'opt_in' | 'opt_out' | 'no_banner', required
  - `closeButtonBehavior` 'accept_all' | 'reject_all' | 'dismiss', required
  - `cookieExpirationDays` number, required
  - `consentVersion` number, required
  - `blockingRules` unknown
  - `gcmExcludeGoogle` boolean, required
  - `shopifyIntegration` boolean, required
  - `createdAt` string, required
  - `updatedAt` string, required

## Other responses

- `401`: Unauthorized
- `404`: Site or banner config not found

---

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