API ReferenceEvent Subscriptions

List subscriptions

Returns your event subscriptions, newest first by default. Filter by status, by a subscribed event type, or by a creation-time window, and sort with sortBy/sort.

Authentication

Authorizationstring

Use the API key format: api-key <token>.

Query parameters

pageintegerOptional1-100Defaults to 50

Zero-based page index. Defaults to 0.

sizeintegerOptional1-100Defaults to 50
Page size between 1 and 100. Defaults to 50.
statusenumOptional

Filter by subscription status: active or paused.

Allowed values:
eventTypeenumOptional
Return only subscriptions that include this event type.
Allowed values:
fromdatetimeOptional

Return subscriptions created at or after this UTC ISO-8601 timestamp.

todatetimeOptional

Return subscriptions created at or before this UTC ISO-8601 timestamp.

sortByenumOptional
Field used to sort the list. Defaults to createdAt.
Allowed values:
sortenumOptional
Sort direction. Defaults to desc.
Allowed values:

Response

One page of subscriptions, newest first.
datalist of objects
Items on the requested page.
pageInfoobject
Paging details for this result set.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
405
Method Not Allowed Error
406
Not Acceptable Error
429
Too Many Requests Error
500
Internal Server Error