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": 1542, "subject": "Schedule update for next week", "message": "<p>Please review your updated shifts for next week.</p>", "replies": [ 3158, 3201 ], "selected_workers": [ { "id": 4521, "name": "Jane Smith" }, { "id": 4587, "name": "Carlos Rivera" } ], "sent_via": [ "email", "text message" ], "status": "sent", "time_sent": "2026-03-15 14:30:00" } ], "total": 42 }
Both page and items_per_page are optional. If omitted, the API returns the first page with the default page size.

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
page
integer
default:1

Page number to retrieve.

Example:

1

​
items_per_page
integer
default:25

Number of announcements per page.

Example:

25

Response

OK

​
announcements
Announcement · object[]

List of announcements for the current page.

​
total
integer

Total number of announcements across all pages.

Example:

42