Search for a subscription profile

Allows you to search for subscription profiles.

Securityapi_key
Request
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:
Name
Program
CompanyOrganization
Owner
Club
Company
Starts
Expires
Size
Used
Created
LastModified

name
string

An optional parameter used to filter for subscription profiles by name

courseId
integer <int32>

An optional parameter used to filter for subscription profiles by the associated course ID

createdAfter
string

An optional parameter used to filter for subscription profiles created after a specified date

createdBefore
string

An optional parameter used to filter for subscription profiles created before a specified date

Responses
200

OK Response

get/SearchClubs
Request samples 
Response samples 
application/json
{
  • "Status": 10,
  • "Error": "string",
  • "TotalCount": 1,
  • "TotalPages": 1,
  • "SearchClubResults": [
    ]
}