Authentication is required.


GET /api/v2/notifications
List account's notifications

Examples

GET /api/v2/notifications
200
{
  "data": [
    {
      "id": "1",
      "type": "notifications",
      "links": {
        "self": "http://test.host/api/v2/notifications/1"
      },
      "attributes": {
        "key": "insight.view",
        "parameters": null,
        "updated-at": "2017-08-29T10:43:51.597+08:00"
      },
      "relationships": {
        "trackable": {
          "links": {
            "self": "http://test.host/api/v2/notifications/1/relationships/trackable",
            "related": "http://test.host/api/v2/notifications/1/trackable"
          }
        },
        "account": {
          "links": {
            "self": "http://test.host/api/v2/notifications/1/relationships/account",
            "related": "http://test.host/api/v2/notifications/1/account"
          }
        },
        "notification-actors": {
          "links": {
            "self": "http://test.host/api/v2/notifications/1/relationships/notification-actors",
            "related": "http://test.host/api/v2/notifications/1/notification-actors"
          }
        }
      }
    }
  ],
  "meta": {
    "total-pages": 1,
    "record-count": 1
  },
  "links": {
    "first": "http://test.host/api/v2/notifications?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "last": "http://test.host/api/v2/notifications?page%5Bnumber%5D=1&page%5Bsize%5D=10"
  }
}

GET /api/v2/notifications/:id
Show a notification

Examples

GET /api/v2/notifications/7
200
{
  "data": {
    "id": "7",
    "type": "notifications",
    "links": {
      "self": "http://test.host/api/v2/notifications/7"
    },
    "attributes": {
      "key": "insight.view",
      "parameters": null,
      "updated-at": "2017-08-29T10:44:01.105+08:00"
    },
    "relationships": {
      "trackable": {
        "links": {
          "self": "http://test.host/api/v2/notifications/7/relationships/trackable",
          "related": "http://test.host/api/v2/notifications/7/trackable"
        }
      },
      "account": {
        "links": {
          "self": "http://test.host/api/v2/notifications/7/relationships/account",
          "related": "http://test.host/api/v2/notifications/7/account"
        }
      },
      "notification-actors": {
        "links": {
          "self": "http://test.host/api/v2/notifications/7/relationships/notification-actors",
          "related": "http://test.host/api/v2/notifications/7/notification-actors"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Notification ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.