curl --request GET \
  --url https://api.rampartcorporation.com/developer/v1/notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'x-account-token: <x-account-token>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "CLIENT_SAVINGS_ANALYSIS_COMPLETED",
      "message": "Your savings analysis has been completed. View the results now!",
      "redirectUrl": "https://partner.rampartcorporation.com/vendor/staples-advantage",
      "isRead": false
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 20,
  "totalPages": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>.

Headers

​
x-account-token
string
required

Account token for authentication

Query Parameters

​
page
integer
default:1

Page number for pagination

​
limit
integer
default:20

Number of items per page

​
isRead
boolean

Filter by read/unread status

​
type
object

Filter by notification type

Response

200 - application/json

Successfully retrieved notifications

​
data
object[]
required

Array of notificatio

​
total
number
required

Total number of notifications

Example:

1

​
page
number
required

Current page number

Example:

1

​
limit
number
required

Number of items per page

Example:

20

​
totalPages
number
required

Total number of pages

Example:

1