v1

latestOpenAPI 3.0.1Apache 2.02026-07-26131220353.8 KB
Subscriptions

Get subscriptions

Retrieves a list of subscriptions for the specific event types (registered for the specific company or organisation by the third party application).

get/v1/subscriptions

Query parameters

statusstring

Filters subscriptions by status. If the value is null, all subscriptions for the specific event types (registered for the specific company or organisation by the third party application) are returned.

event_typesstring[]

Filters subscriptions by versioned event types. If the value is null, all subscriptions for the specific event types (registered for the specific company or organisation by the third party application) are returned.

beforestring

Lower bound of the page of data to return (cannot be used together with [after] or [offset]).

afterstring

Upper bound of the page of data to return (cannot be used together with [before] or [offset]).

offsetinteger

Offset of the page of data to return (cannot be used together with [before] or [after]).

limitinteger

The maximum amount of items to return.

sorting_keysstring[]

The keys to sort the results by.

sorting_orderPageOrder[]

The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.

Response

Returns list of subscriptions.