Get Site Banners

Calls externally-published Site Banners for a specified site domain.

Collection Endpoint

This API does not have a collection response.

Entity Endpoint

https://[KB site domain]/[group name]/api/v2/banner/

Example: https://kb.wisc.edu/demo/api/v2/banner/

Entity Sample Response

{
    "siteName": "KB Demo KnowledgeBase",
    "banner": "<p>The specific HTML content of my active banner.</p>",
    "headerActivation": "2025-07-27 23:15:35",
    "headerExpiration": "2025-08-18 13:00:00",
    "_links": {
        "self": {
            "href": "https://kb.wisc.edu/demo/api/v2/banner/"
        }
    }
}

Success Response

Code: 200 OK
Content: Content-type: application/hal json

Error Response

Code: 404 Page Not Found
Content: { error : "The server cannot find the requested resource." }

OR

Code: 405 Method Not Allowed
Content: { error : None }

Notes

This API will only return a result if the banner is currently active on the external site. If banner content was created, but the "Activation" time stamp is in the future or the "Expiration" time stamp is in the past, the API call will return a 404 error.