Content

List active site notices

Returns the operator-authored banners the website is currently showing, best first. Only published notices inside their display window appear, so an empty array is the normal state.

No API key required.

get/v1/notices

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/notices
  • Auth: one of:
    • none
    • API key in header X-API-Key
    • HTTP bearer

Response

List active site notices

successboolean required

Always true on a successful response. Every error carries false and an error object instead.

Example response

{
  "success": true,
  "data": {
    "notices": [
      {
        "id": "silhouettes-2026-05",
        "label": "Notice",
        "highlight": "Scheduled maintenance on Sunday.",
        "detail": "The API stays up; the website may be briefly unavailable.",
        "ctaLabel": "Read the changelog",
        "ctaUrl": "/changelog",
        "startsAt": "2026-05-01T00:00:00.000Z",
        "endsAt": "2026-09-30T00:00:00.000Z"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.