Skip to main content
Loading...

API docs by

Ibx Notifications Search

Request

Based on filtering criteria, this API returns a summary list of IBX notifications received by a user.

Query
offsetinteger, >= 0

The start index from which the list is created.

limitinteger, [ 1 .. 100 ]

Number of entries in response.

sortsArray of strings

Notification sort to get the notification even in the response sorted in the particular order. for example, use '-id' to sort the notification by id in descending order. And 'id' for ascending order. For descending order, the field name should be prefixed with '-'. Default sort is -startDate.

Default:"-startDate"
Items Enum:"id""status""startDate""endDate""type""-id""-status""-startDate""-endDate""-type"
Headers
Authorizationstring, >= 1required

Specify the Access token with prefix 'Bearer '.

Bodyapplication/json
filterobject

IBX Notification filter.

Payload
{
  "filter": {
    "ibxs": [ … ],
    "types": [ … ],
    "statuses": [ … ],
    "dateRange": { … }
  }
}

Responses

Success Response.

Bodyapplication/json
dataArray of objects(IbxNotificationSummary)
pageobject(PageInfo)
Response
{
  "data": [
    { … }
  ],
  "page": {
    "limit": 10,
    "offset": 30,
    "total": 223,
    "sorts": [ … ]
  },
  "_links": {
    "next": { … },
    "self": { … },
    "previous": { … }
  }
}
Was this page helpful?