v1

latestOpenAPI 3.0.12026-07-2471156164.1 KB
Knowledge Alerts

List announcements

Returns all announcements owned by the authenticated user. A maximum of 50 announcements will be returned. If more than 50 announcements exist, a link to the next page of results will be included in the Link header

get/api/v1/alerts

Query parameters

tokenstring

Paging token

sortField'cardTitle' | 'dateSent' | 'percentRead' | 'collection' | 'sentBy'

Sort field

sortOrder'ASC' | 'DESC'

Sort order

view'ALL_SENT' | 'MY_SENT' | 'ALL_SCHEDULED' | 'MY_SCHEDULED'

Alerts View

Response

successful operation

readCountinteger
unreadCountinteger
alertIdstring
cardTitlestring
dateSentstring date-time
collectionHexColorstring
percentReadinteger
notestring
scheduledSendDatestring date-time