List announcements

List the announcements Everee has published for you, newest first. A company's credentials see what applies to that company. A partner API key sees every announcement for its audience; narrow it with company-id.

List the announcements Everee has published for you, newest first. Filter by kind, category, reader, key, active, or since. With a partner API key, pass company-id to see only what applies to one of your companies.

See the Guide to the Announcements API for the kinds and categories, which announcements you see, and how to poll for what's new.

Query Params
string
enum

Only announcements of this kind.

Allowed:
string
enum

Only announcements in this category.

string
enum

Only announcements for this reader. CUSTOMER returns the ones written so you can show them to your customers as is.

Allowed:
string

Only announcements with this key, such as bank-holiday:2026-11-26.

boolean

true: only announcements not past their displayUntil.

date-time

Only announcements published at or after this time. ISO 8601, such as 2026-11-01T00:00:00Z.

integer

With a partner API key: only announcements that apply to this company, one of your own. Another partner's company returns 404.

integer
Defaults to 0

The page to return, starting at 0.

integer
≤ 100
Defaults to 20

Announcements per page. At most 100.

Responses

400
  1. A filter is invalid, such as a since that isn't an ISO 8601 time.
404
  1. company-id isn't one of your companies.
Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json