Allows you to search for an organization's subscription training keys.
A 0-based index of the paged results you wish to receive. In general, you should start with a value of zero and increment it as you need to retrieve additional results. If not supplied, a value of 0 is used (the first page of results).
Indicates how many results you want per page. If not supplied, a default value of 20 is used (20 records per page).
The value you want to sort by. If not supplied, a default value of "TrainingKey" is used.
Possible values:
- TrainingKey
- ContentExpiry
- SubscriptionProfileName
- Created
- CreatedById
- LastModified
- LastModifiedById
- ExpirationDate
Filter subscription training keys by the associated organization id. When specified, only the subscription training keys associated with this organization will be returned.
Filter for a specific subscription training key. When specified, only the subscription training key that matches this value will be returned.
Filter subscription training keys by the associated user id. When specified, only the subscription training keys that have been created by this user id value will be returned.
Filter subscription training keys created before a specified date. When used in conjunction with the "createdAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Filter subscription training keys created after a specified date. When used in conjunction with the "createdBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Filter subscription training keys expiring before a specified date. When used in conjunction with the "expiresAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Filter subscription training keys expiring after a specified date. When used in conjunction with the "expiresBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Filter subscription training keys last modified before a specified date. When used in conjunction with the "lastModifiedAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Filter subscription training keys last modified after a specified date. When used in conjunction with the "lastModifiedBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Filter subscription training keys by the user id that last modified the record. When specified, only the subscription training keys last modified by this user will be returned.
Filter subscription training keys by subscription profile id. When specified, only subscription training keys that are associated with this value will be returned.
Filter subscription training keys when the content is expiring before a specified date. When used in conjunction with the "contentExpiryAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Filter subscription training keys when the content is expiring after a specified date. When used in conjunction with the "contentExpiryBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
OK Response
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
See SearchSubscriptionsResult.
The Id of the Subscription Training Key.
The Id of the Organization associated with this Subscription Training Key.
The name of the Organization associated with the subscription Training Key.
The subscription profile's unique identifier.
The subscription profile's name.
The subscription training key value
The maximum number of times the subscription training key can be used.
When the subscription training key ends or expires (in Unix epoch time).
When the subscription training key content ends or expires (in Unix epoch time).
When the subscription training key was created (in Unix epoch time).
When the subscription was last modified (in Unix epoch time).
The user id that created the subscription training key
The user id that last modified the subscription training key