Get Announcement

This endpoint serves the purpose of fetching announcement based on unique announcement ID.

GET /announcements/{id}

Get Announcement

cURL

curl --request GET \
  --url https://api.roostedhr.com/api/1_12/announcements/{id} \
  --header 'X-API-KEY: <api-key>'

200

{
  "id": 123,
  "subject": "<string>",
  "message": "<string>",
  "replies": [
    123
  ],
  "selected_workers": [
    {
      "id": 123,
      "name": "<string>"
    }
  ],
  "sent_via": [
    "<string>"
  ],
  "status": "<string>",
  "time_sent": "<string>"
}

Authorizations

X-API-KEY · string · header · required

Path Parameters

id · string · required

Response

200

application/json

OK

id · integer

subject · string

message · string

replies · integer[]

selected_workers · object[]

Show child attributes

sent_via · string[]

Possible options: email, text message or both

status · string

Pending or Sent

time_sent · string