Docs
Notifications

List notifications

List the caller’s notifications (cursor-paginated)

GET
/v2/workspaces/{workspaceId}/notifications

Path Parameters

workspaceIdnumber

Query Parameters

unreadOnly?boolean

Only return unread notifications.

Defaultfalse
cursor?string

Opaque cursor from a previous page.

limit?number
Default50
Range1 <= value <= 100

Response Body

curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/notifications?unreadOnly=false&cursor=string&limit=50"
{
  "data": [
    {
      "id": 0,
      "type": "string",
      "severity": "critical",
      "category": "string",
      "title": "string",
      "body": "string",
      "emailAccountId": 0,
      "readAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "isRead": true
    }
  ],
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "pagination": {
    "page": 0,
    "per_page": 0,
    "total": 0,
    "total_pages": 0,
    "has_more": true
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}