Get all banners. | Unleash Documentation

Enterprise feature

Returns a list of all configured banners.

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

bannersSchema

bannerslist of objects

A list of banners.

401

Unauthorized Error

1	{
2	"banners": [
3	{
4	"id": 7,
5	"message": "Reminder to everyone: Maintenance is scheduled for 2337-12-27.",
6	"createdAt": "2023-12-27T13:37:00+01:00",
7	"enabled": true,
8	"variant": "info",
9	"sticky": true,
10	"icon": "build",
11	"link": "dialog",
12	"linkText": "Learn more",
13	"dialogTitle": "Learn more about it here",
14	"dialog": "# Information\n\nMaintenance is scheduled.\n\n## More details\n\nThis is an example dialog that supports Markdown."
15	}
16	]
17	}

$	curl https://app.unleash-instance.example.com/api/admin/banners \
>	-H "Authorization: <apiKey>"