Badge Counters

GET https://api.speakap.io/networks/:eid/badgecounters/

Use cases

  • View the authorized user’s badge counters in a specific network

Required Application Permission

N/A

Request

URI:/networks/{networkEID}/badgecounters/
Method:GET
Accept:application/vnd.speakap.api-v1.4+json
Authentication:OAuth 2.0

Response

200
Returns the badge counters resource

Properties

Name Type Description
numAdminAlerts integer Since 1.0.2 Number of alerts in the admin category
numUnreadAlerts integer Number of unread alerts
numUnreadConversations integer Number of unread conversations
numUnreadNewsItems integer Number of unread news items
numUnreadAlertsCoalesced integer Number of unread coalesced alerts

Example

{
    "_links": {
        "self": {
            "href": "https://api.speakap.io/networks/1234567890ABCDEF/badgecounters/"
        },
    },
    "numUnreadConversations": 1,
    "numUnreadAlerts": 7,
    "numUnreadNewsItems": 2,
    "numAdminAlerts": 0,
    "numUnreadAlertsCoalesced": 3
}