Notification

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

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
}

Changes

Changed in 3 of the 26 revisions of this API.6

Feb 10, 2023b219791ce4eb1See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Jun 15, 2020517edd3aa9ad2See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Mar 11, 20205ed31e104b6f3See the full diff
- ○
  the endpoint scheme security ApplicationSecret was added to the API
  api-security-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history