announcements

Get active announcements

Retrieve active, unread announcements for the authenticated user filtered by operating system

get/announcements

Request

  • Base URL
    https://api.focusbear.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

os_name'ios' | 'android' | 'mac' | 'windows' | 'web' | 'unknown' required
Example:ios

Operating system name (case-insensitive)

Response

Successfully retrieved announcements

Example response

{
  "announcements": [
    {
      "id": "ann_2024_11_maintenance",
      "type": "maintenance",
      "heading": "Scheduled Maintenance",
      "details": "We'll be performing system maintenance on Nov 25th from 2-4 AM UTC.",
      "details_url": "https://example.com/maintenance-info",
      "expiry_date": "2024-11-26",
      "priority": "high",
      "operating_system": "ios",
      "created_at": "2024-11-15T10:00:00.000Z",
      "updated_at": "2024-11-15T10:00:00.000Z"
    }
  ]
}

Changes

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