Retrieve email notification events

Request

Retrieves a list email notification events.
Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/email-notifications?limit=0&offset=0' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of email notification events retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger
Maximum number of items per page.
Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
eventTypestring(EventType)read-only
Type of Rebilly event.
Enum:"account-password-reset-requested""account-verification-requested""aml-list-possibly-matched""application-instance-disabled""application-instance-enabled""balance-transaction-settled""coupon-application-removed""coupon-applied""coupon-expiration-modified""coupon-expired"
countintegerread-only

Total number of binds with send-email actions per event.

activeCountintegerread-only

Number of active binds with send-email actions per event.

notificationsArray of objectsread-only
List of notifications.
_linksArray of objects(SelfLink)read-only
Related links.
]
Response
[
  {
    "eventType": "account-password-reset-requested",
    "count": 0,
    "activeCount": 0,
    "notifications": [ … ],
    "_links": [ … ]
  }
]