Sign in

v4

OpenAPI 3.0.02026-07-31257282489.4 KB
Engagement News

Get all engagement news articles

Get the engagement news articles of a project, newest first. Supports filtering by any field via query parameters, plus skip, limit and sort (e.g. sort=-createdAt). limit defaults to 1000 when omitted; when supplied, values above 100 are clamped to 100. Filtering by project or organisation is rejected. Pass withoutChangelogs=true (exact lowercase string) to exclude changelog entries (news items with subType CHANGELOG); any other value is ignored.

get/engagement/news

Query parameters

withoutChangelogsstring

Headers

projectstring required

Response

Ok

{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:trigger","oasType":"schema","type":"unknown"}
pageFilterDelaynumber double
pageFilterstring
eventTriggerDelaynumber double
eventTriggerstring
actionTypestring
sentAtstring date-time
{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:stats","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:subject","oasType":"schema","type":"unknown"}
coverImageUrlstring
subTypestring
searchContentstring
{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:data","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:conditions","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:config","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:OutboundDocument:allOf:properties:message","oasType":"schema","type":"unknown"}
aiSummaryOutdatedboolean
aiSummarystring
startSendingAfterstring date-time required
stopSendingAfterstring date-time required
pageFilterType'is' | 'contains' | 'isnot' | 'notcontains' | 'startswith' | 'endswith' | 'empty' | 'notempty' required
frequencyDaysnumber double required
frequencystring required
frequencyTypestring required
sentboolean required
soundboolean required
newTriggerboolean required
formatstring required
updatedAtstring date-time required
statusstring required
targetAudiencestring required
createdAtstring date-time required
hiddenboolean required
tagsstring[] required
namestring required
typestring required