List alerts
This endpoint returns a list of alerts within Orb.
The request must specify one of customer_id, external_customer_id, or subscription_id.
If querying by subscripion_id, the endpoint will return the subscription level alerts as well as the plan level alerts associated with the subscription.
The list of alerts is ordered starting from the most recently created alert. This endpoint follows Orb’s standardized pagination format.
Authorizations
API Keys can be issued in the Orb's web application.
Query Parameters
The number of items to fetch. Defaults to 20.
1 < x < 1000Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.
Fetch alerts scoped to this customer_id
Fetch alerts scoped to this external_customer_id
Fetch alerts scoped to this subscription_id
Was this page helpful?