v1

latestOpenAPI 3.1.02026-07-17254060.5 KB
notices

Get notices

Get a list of notices that match the filters, ordered by the last-repeated time.

get/v1/notices

Query parameters

user-idinteger

Filter notices by user ID. Only one user ID can be specified. This parameter can only be used by admin users.

users'all'

If set to "all", return notices for all users. Cannot be used with user-id. This parameter can only be used by admin users.

typesstring[]

Filter notices by type. To specify multiple types, include this parameter multiple times.

keysstring[]

Filter notices by keys. To specify multiple keys, include this parameter multiple times.

afterstring date-time

Filter notices occurring after the specified time.

timeoutstring duration

The maximum time duration to wait for notices. If no notices are available within this time, an empty list is returned.

Response

Notices successfully retrieved.

typestring

Response type, "sync".

status-codeinteger

HTTP response status code.

statusstring

The description of the HTTP status code.

See the IANA list.