List notifications
Returns a paginated list of notifications. Use the query parameters to page through results.
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.
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.
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 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 Paddle ID specified. Pass a transaction, customer, or subscription ID.
Return entities up to a specific time.
Return entities from a specific time.
Response
Represents a notification entity.
Unique Paddle ID for this notification, prefixed with ntf_.
Type of event sent by Paddle, in the format entity.event_type.
Status of this notification.
Notification payload. Includes the new or changed event.
RFC 3339 datetime string of when this notification occurred.
RFC 3339 datetime string of when this notification was delivered. null if not yet delivered successfully.
RFC 3339 datetime string of when this notification was replayed. null if not replayed.
Describes how this notification was created.
RFC 3339 datetime string of when this notification was last attempted.
RFC 3339 datetime string of when this notification is scheduled to be retried.
How many times delivery of this notification has been attempted. Automatically incremented by Paddle after an attempt.
Unique Paddle ID for this notification setting, prefixed with ntfset_.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Keys used for working with paginated results.