Skip to main content

List Broadcast Messages

This endpoint lists all broadcast messages. Broadcast Message is a feature which allows a specific user to send messages and announcements to a larger group of users at once.

info

This operation requires authentication

HTTP Request

GET /api/v2/notification/banner/

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalseNumber of results to return per page
limitqueryintegerfalseNumber of results to return per page
offsetqueryintegerfalseThe initial index from which to return the results

Example Request

const headers = {
'Accept':'application/json',
'Authorization: Bearer <token>'
};

fetch('/api/v2/notification/banner/',
{
method: 'GET',

headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});

Responses

StatusMeaningDescriptionSchema
200OKResponse status codeTargeted Banner Visibility

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
» countintegerfalsenoneTotal results count
» nextstring(uri)¦nullfalsenoneNext page url
» previousstring(uri)¦nullfalsenonePrevious page url
» resultslist(TargetedBannerVisibility)falsenoneList of results

Example responses

{
"count": "integer",
"next": "string(uri)",
"previous": "string(uri)",
"results": [
{
"id": "integer",
"banner": {
"html": "string",
"type_banner": "string"
},
"added_at": "string",
"disposed_at": "string",
"viewed_at": "string"
}
]
}