API Reference

Learn how to access UNLOQ end points

GET /notifications/:id

Read info about a given notification

GET https://api.unloq.io/v1/notifications/:id
Headers:
   Authorization: Bearer {your application API Key}
   Content-Type: application/json
URL parameters
  • id (string, required) - The id of the notification to be read.
Result format (200 OK)
{
  "type": "api.application.notification.read",
  "result": {
    "id": "123456",
    "type": "SURVEY",
    "status": "COMPLETED",
    "title": "test notif",
    "content": "with a test message",
    "level": 1,
    "open_count": 1,
    "send_at": "2016-11-03T15:55:44.000Z",
    "name": "test 1234",
    "actions": [
      {
        "id": "123",
        "type": "SUBMIT",
        "text": "naye",
        "request_id": "11111"
      },
      {
        "id": "1234",
        "type": "CLOSE",
        "text": "aye",
        "request_id": "11111"
      }
    ],
    "receivers": [
      "1"
    ],
    "notifications": {
      "meta": {
        "total_count": 1,
        "page_count": 1,
        "current_count": 1,
        "current_page": 1
      },
      "result": [
        {
          "id": "12345",
          "application_id": "123",
          "title": "test notif",
          "content": "with a test message",
          "opened": true,
          "responded": true,
          "deleted": false,
          "in_device": true,
          "level": 1,
          "type": "survey",
          "created_at": "2016-11-03T15:55:54.000Z",
          "country": {
            "code": "RO",
            "name": "Romania"
          },
          "opened_at": null,
          "responded_at": "2016-11-03T15:56:12.000Z",
          "actions": [
            {
              "id": "123",
              "action_id": "1234",
              "type": "SUBMIT",
              "text": "naye"
            }
          ],
          "device": {
            "id": "123456",
            "ip": "2.2.2.2",
            "type": "ANDROID",
            "version": "88"
          },
          "user": {
            "account": {
              "id": 1234,
              "first_name": "John",
              "last_name": "Doe",
              "image": "https://image.jpg",
              "is_active": true
            },
            "id": 123,
            "email": "john@doe.com"
          }
        }
      ]
    }
  }
}
      

Have a question? You can always send us an email at support@unloq.io, or contact us on chat.

For security related concerns, please visit our Security page.