Notification
Get notifications
API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Notification
Get notifications
Get all sent notifications
GET
/
notifications
curl -X GET \
/notifications \
--header "Authorization: Bearer <token>"
{
"data": [
{
"id": "<string>",
"type": {
"name": "<string>",
"description": "<string>"
},
"channel": "email",
"payload": [
"<string>"
],
"recipients": [
"<string>"
],
"status": "sent",
"createdAt": "2023-11-07T05:31:56Z",
"deliverAt": "2023-11-07T05:31:56Z",
"sentAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}
Authorizations
Value for the Authorization header parameter.
Query Parameters
The collection page number
The number of items per page
Required range:
0 <= x <= 100
Response
200
application/json
SentNotification collection
Available options:
email
, sms
, slack
, letter
Available options:
sent
, failed
, pending
Was this page helpful?
curl -X GET \
/notifications \
--header "Authorization: Bearer <token>"
{
"data": [
{
"id": "<string>",
"type": {
"name": "<string>",
"description": "<string>"
},
"channel": "email",
"payload": [
"<string>"
],
"recipients": [
"<string>"
],
"status": "sent",
"createdAt": "2023-11-07T05:31:56Z",
"deliverAt": "2023-11-07T05:31:56Z",
"sentAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}