<- Subscriptions API

Subscriptions API

All versions ->

List subscription events

GET

 /v2/subscriptions/{subscription_id}/events

Lists all events for a specific subscription.

Permissions:SUBSCRIPTIONS_READ

Guide

Subscription Actions and Events

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

subscription_id

string

Required

The ID of the subscription to retrieve the events for.

Link to section

Query parameters

Link to section

cursor

string

When the total number of resulting subscription events exceeds the limit of a paged response, specify the cursor returned from a preceding response here to fetch the next set of results. If the cursor is unset, the response contains the last page of the results.

For more information, see Pagination.

Link to section

limit

integer(32-bit)

The upper limit on the number of subscription events to return in a paged response.

Link to section

Response fields

Link to section

errors

Errors encountered during the request.

Link to section

subscription_events

The retrieved subscription events.

Link to section

cursor

string

When the total number of resulting subscription events exceeds the limit of a paged response, the response includes a cursor for you to use in a subsequent request to fetch the next set of events. If the cursor is unset, the response contains the last page of the results.

For more information, see Pagination.