List notifications
Changed onReturns a paginated list of notifications created in the last 90 days. Use the query parameters to page through results.
Notifications older than 90 days aren't retained.
Request
- Base URLhttps://sandbox-api.paddle.com
- AuthHTTP bearer
Query parameters
Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.
Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.
Default: 50; Maximum: 200.
Return entities related to the specified notification destination. Use a comma-separated list to specify multiple notification destination IDs.
Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].
Valid fields for ordering: id.
Return entities that match a search query. Searches id and type fields.
Return entities that match the specified status. Use a comma-separated list to specify multiple status values.
Return entities that contain the value specified. Pass a Paddle ID or email address that appears in the event payload, or part of one. Complete Paddle IDs and email addresses match exactly; partial values match as a prefix or substring, and must be at least three characters.
Return entities up to a specific time. Pass an RFC 3339 datetime string.
Return entities from a specific time. Pass an RFC 3339 datetime string.
Headers
Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.
Response
The request has succeeded.
Example response
{
"data": [
{
"id": "ntf_01ghbkd0frb9k95cnhwd1bxpvk",
"payload": {
"event_id": "evt_01gks14ge726w50ch2tmaw2a1x",
"occurred_at": "2024-10-12T07:20:50.52Z",
"notification_id": "ntf_01ghbkd0frb9k95cnhwd1bxpvk"
},
"occurred_at": "2024-10-12T07:20:50.52Z",
"delivered_at": "2024-10-12T07:20:50.52Z",
"replayed_at": "2024-10-12T07:20:50.52Z",
"last_attempt_at": "2024-10-12T07:20:50.52Z",
"retry_at": "2024-10-12T07:20:50.52Z",
"notification_setting_id": "ntfset_01gt21c5pdx9q1e4mh1xrsjjn6"
}
],
"meta": {
"request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355",
"pagination": {
"estimated_total": 999
}
}
}Changes
- info
added the new optional
headerrequest parameterSkip-Count
- info
- breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type, and format fromdate-timeto no format for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromobjectto no type for status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - warning
removed the optional property
/from the response with the status - info
added to the
response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
removed
subschema #2from the//response propertyallOflist for the response status - info
added
subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #2to the//response propertyanyOflist for the response status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
removed the
address.createdenum value from the//response property for the response status - info
removed the
address.importedenum value from the//response property for the response status - info
removed the
address.updatedenum value from the//response property for the response status - info
removed the
adjustment.createdenum value from the//response property for the response status - info
removed the
adjustment.updatedenum value from the//response property for the response status - info
removed the
api_key.createdenum value from the//response property for the response status - info
removed the
api_key.expiredenum value from the//response property for the response status - info
removed the
api_key.expiringenum value from the//response property for the response status - info
removed the
api_key.revokedenum value from the//response property for the response status - info
removed the
api_key.updatedenum value from the//response property for the response status - info
removed the
business.createdenum value from the//response property for the response status - info
removed the
business.importedenum value from the//response property for the response status - info
removed the
business.updatedenum value from the//response property for the response status - info
removed the
customer.createdenum value from the//response property for the response status - info
removed the
customer.importedenum value from the//response property for the response status - info
removed the
customer.updatedenum value from the//response property for the response status - info
removed the
deliveredenum value from the//response property for the response status - info
removed the
discount.createdenum value from the//response property for the response status - info
removed the
discount.importedenum value from the//response property for the response status - info
removed the
discount.updatedenum value from the//response property for the response status - info
removed the
eventenum value from the//response property for the response status - info
removed the
failedenum value from the//response property for the response status - info
removed the
needs_retryenum value from the//response property for the response status - info
removed the
not_attemptedenum value from the//response property for the response status - info
removed the
payment_method.deletedenum value from the//response property for the response status - info
removed the
payment_method.savedenum value from the//response property for the response status - info
removed the
payout.createdenum value from the//response property for the response status - info
removed the
payout.paidenum value from the//response property for the response status - info
removed the
price.createdenum value from the//response property for the response status - info
removed the
price.importedenum value from the//response property for the response status - info
removed the
price.updatedenum value from the//response property for the response status - info
removed the
product.createdenum value from the//response property for the response status - info
removed the
product.importedenum value from the//response property for the response status - info
removed the
product.updatedenum value from the//response property for the response status - info
removed the
replayenum value from the//response property for the response status - info
removed the
report.createdenum value from the//response property for the response status - info
removed the
report.updatedenum value from the//response property for the response status - info
removed the
subscription.activatedenum value from the//response property for the response status - info
removed the
subscription.canceledenum value from the//response property for the response status - info
removed the
subscription.createdenum value from the//response property for the response status - info
removed the
subscription.importedenum value from the//response property for the response status - info
removed the
subscription.past_dueenum value from the//response property for the response status - info
removed the
subscription.pausedenum value from the//response property for the response status - info
removed the
subscription.resumedenum value from the//response property for the response status - info
removed the
subscription.trialingenum value from the//response property for the response status - info
removed the
subscription.updatedenum value from the//response property for the response status - info
removed the
transaction.billedenum value from the//response property for the response status - info
removed the
transaction.canceledenum value from the//response property for the response status - info
removed the
transaction.completedenum value from the//response property for the response status - info
removed the
transaction.createdenum value from the//response property for the response status - info
removed the
transaction.paidenum value from the//response property for the response status - info
removed the
transaction.past_dueenum value from the//response property for the response status - info
removed the
transaction.payment_failedenum value from the//response property for the response status - info
removed the
transaction.readyenum value from the//response property for the response status - info
removed the
transaction.revisedenum value from the//response property for the response status - info
removed the
transaction.updatedenum value from the//response property for the response status - info
removed
subschema #2from the//response propertyoneOflist for the response status - info
removed
subschema #2from the//response propertyoneOflist for the response status - info
removed
subschema #2from the//response propertyoneOflist for the response status - info
removed
subschema #2from the//response propertyoneOflist for the response status - info
the
//response's property pattern^ntf_[a-z\d]{26}$was removed for the status - info
the
//response's property pattern^ntfset_[a-z\d]{26}$was removed for the status
- breaking