Banners

Retrieve all announcement banners

Superadmin-only. Returns all global announcement banners.

get/api/v1/banners/search

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/banners/search
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Response

searchBanners 200 response

idstring
messagestring required
type'INFO' | 'WARNING' | 'ERROR'
startDatestring date-time nullable
endDatestring date-time nullable
tenantIdstring nullable
activeboolean

Example response

[
  {
    "endDate": "2000-01-23T04:56:07.000+00:00",
    "tenantId": "tenantId",
    "active": true,
    "id": "id",
    "message": "message",
    "type": "INFO",
    "startDate": "2000-01-23T04:56:07.000+00:00"
  }
]

Changes

No recorded changes to this operation across all 7 revisions of this API.