Search for subscription assignments

  • Updated on Jul 16, 2024
  • 2 minute(s) read
Prev Next
Get
/SearchSubscriptions

Allows you to search for user's subscription assignments.

Security
API Key
Header parameter nameapi_key
Query parameters
pageIndex
integer (int32)

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).

pageSize
integer (int32)

Indicates how many results you want per page. if not supplied, a default value of 100 is used.

sort
string

The value you want to sort by.
Possible values:

  • UserId
  • ExternalUserId
  • Subscription
  • Starts
  • Expires
  • TargetCompletion
  • Created
  • LastModified
userId
integer (int32)

An optional parameter used to filter subscriptions by the associated userid. When specified, only user subscriptions that have an associated userid that matches this value will be returned.

userExternalId
string

An optional parameter used to filter subscriptions by the associated user external id. When specified, only user subscriptions that have an associated external user id that matches that value will be returned.

subscriptionId
integer (int32)

An optional parameter used to filter subscriptions by subscription id. When specified, only user subscriptions that matches this value will be returned.

createdAfter
integer (int64)

An optional parameter used to filter subscriptions 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.

createdBefore
integer (int64)

An optional parameter used to filter subscriptions 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.

Responses
200

OK Response

Expand All
object
Status
integer (int32)

Indicates the status of the API request.

0 = Success
10 = Error
20 = Not found
30 = Invalid integration key

Example10
Error
string | null

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).

TotalCount
integer (int32)

The total number of results that match the search conditions, not all of which may be in the current result set.

Example1
TotalPages
integer (int32)

The total number of result pages that match the search conditions.

Example1
SearchSubscriptionsResults
Array of object (SearchSubscriptionsResult)

See SearchSubscriptionsResult.

object
SubscriptionProfileId
integer (int32)

The subscription profile's unique identifier.

Example523
SubscriptionProfileName
string

The subscription profile's name.

Example.Net Club
Starts
string | null

When the subscription starts (in Unix epoch time).

Example2021-03-19T22:16:07.967Z
Expires
string | null

When the subscription ends or expires (in Unix epoch time).

Example2022-03-19T22:15:59.997Z
LastModified
string | null

When the subscription was last modified (in Unix epoch time).

Example2021-04-19T11:23:02.567Z
Created
string | null

When the subscription was created (in Unix epoch time).

Example2021-03-19T22:16:07.967Z