Skip to content

Latest commit

 

History

History
12 lines (9 loc) · 13 KB

File metadata and controls

12 lines (9 loc) · 13 KB

ListAllSubscriptionsRequest

Fields

Field Type Required Description Example
from JsonNullable<String> Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
result set.
limit JsonNullable<Long> The maximum number of items to return. Defaults to 50 items. 50
profileId JsonNullable<String> The identifier referring to the profile you wish to retrieve subscriptions for.

Most API credentials are linked to a single profile. In these cases the profileId is already implied.

To retrieve all subscriptions across the organization, use an organization-level API credential and omit the
profileId parameter.
testmode Optional<Boolean> Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query
parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by
setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
idempotencyKey Optional<String> A unique key to ensure idempotent requests. This key should be a UUID v4 string. 123e4567-e89b-12d3-a456-426