API reference

Announcements. 1 operations.

1 of them work. Each needs a bearer token with its scope. All operations.

Operations

GET/api/v1/announcementsannouncements.progressannouncements.read

Answer

array of Announcement

Errors: 401, 403, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/announcements

Schemas 1

Announcement

Announcement is how far an announcement's sending has come.

`at`required	string (date-time)
`by`required	string
`done`required	boolean
`failed`required	integer
`id`required	integer
`queued`required	integer
`recipients`required	integer
`sent`required	integer
`subject`required	string
`topic`required	string
`waiting`required	integer
`withheld`required	integer

Made from engine/internal/openapi/openapi.json at commit 6c4cbd921. The contract-only operations come from the engine’s stub file, engine/internal/ops.