Skip to main content
GET
/
announcements
Get Announcements
curl --request GET \
  --url https://api.roostedhr.com/api/1_12/announcements \
  --header 'X-API-KEY: <api-key>'
{
  "announcements": [
    {
      "id": 123,
      "subject": "<string>",
      "message": "<string>",
      "replies": [
        123
      ],
      "selected_workers": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "sent_via": [
        "<string>"
      ],
      "status": "<string>",
      "time_sent": "<string>"
    }
  ],
  "total_items": 123
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

page
integer

Current page

per_page
integer

Items per page

Response

OK

announcements
object[]
total_items
integer