Search for a subscription profile

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

Allows you to search for subscription profiles.

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:
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

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
SearchClubResults
Array of object (SearchClubResult)

See SearchClubResult.

object
ClubId
integer (int32)

The subscription profile's unique identifier.

Example523
Name
string

The subscription profile's name.

Example.Net Subscription Profile
ProgramId
integer (int32)

The subscription profile's program.

Example1
ProgramName
string

The subscription profile's program name.

ExampleTraining
OrganizationId
integer (int32)

The subscription profile's organization.

Example387
OrganizationName
string

The subscription profile's organization name.

ExampleABC Training Company
Price
number

The subscription profile's price.

Example0
LastModified
string

When the subscription profile was last modified.

Example2017-04-19T22:16:07.967+0000
Created
string

When the subscription profile was created.

Example2012-04-17T15:21:21.953+0000
CourseIds
Array of object (ClubAssociatedCourses)

A collection of ClubAssociatedCourses.

object
CourseId
integer (int32)

The subscription profile's associated couseId.

Example8992
Name
string

The course name.

Example.NET Programming Fundamentals