v26

latestOpenAPI 3.0.0raw.githubusercontent.com2023-06-09375890.9 KB
Notification

Get a specific device's inbox

Get a specific device's inbox

get/notification/inbox/fordevice/{deviceID}

Path parameters

deviceIDstring required

The unique identifier for your device.

Query parameters

sincestring date-time

A date that we will use to retrieve items. When provided we will only retrieve items since that date.

limitnumber

The maximum number of results to retrieve.

skipnumber

The number of results to skip.

Response

OK

countnumber
unreadnumber

Example response

{
  "inboxItems": [
    {
      "_id": "1d9e80ef851d212aca82cf23",
      "notification": "1d9e80ef851d212aca82cf23",
      "message": "Ready for beers?",
      "title": "message",
      "subtitle": "message",
      "subject": "message",
      "attachment": {
        "mimeType": "image/jpeg",
        "name": "Test Attachment",
        "uri": "https://domain.com/image"
      },
      "extra": {
        "key1": "value1",
        "key2": "value2"
      }
    }
  ],
  "count": 10,
  "unread": 1
}