Skip to main content
GET
Get Announcement

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
integer
required

Unique announcement ID.

Example:

1542

Response

OK

An announcement sent to workers via email, text message, or both.

id
integer

Unique identifier for the announcement.

Example:

1542

subject
string

Subject line of the announcement.

Example:

"Schedule update for next week"

message
string

Body content of the announcement. May contain HTML.

Example:

"<p>Please review your updated shifts for next week.</p>"

replies
integer[]

List of admin IDs designated to receive worker replies.

Example:
selected_workers
object[]

Workers the announcement was sent to. Empty when sent to all workers.

Example:
sent_via
enum<string>[]

Delivery channels used for the announcement.

Available options:
email,
text message
Example:
status
enum<string>

Current delivery status of the announcement.

Available options:
pending,
sent
Example:

"sent"

time_sent
string

Timestamp when the announcement was sent.

Example:

"2026-03-15 14:30:00"