Get a banner

GET/banners/{id}

Returns one banner. An unknown id, a deleted banner, another organisation's banner, or a banner the reader may not see (outside its display window or for other roles, for a user who cannot change the organisation) returns 404. Use GET /banners to list them. Changes nothing.

Path parameters

idintegerRequired#
The banner's id. Banners are keyed by integer ids, not UUIDs: a whole number from 1 to 2147483647.

Query parameters

fieldsstring#
Comma-separated top-level fields to return. id is always returned.

Responses

200

The banner.

Banner

{
  "data": {
    "id": 1,
    "title": "string",
    "description": "string",
    "type": "dismissible",
    "display_from": "2026-06-12T10:00:00+00:00",
    "display_until": "2026-06-12T10:00:00+00:00",
    "background_colour": "string",
    "text_colour": "string",
    "expanded": true,
    "role_ids": [
      1
    ],
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error

403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error

404

Resource not found (error.code = not_found).

Error

422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/banners/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"