Retrieve subscription assignment information by external platform ID

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

Allows you to get information about a subscription assignment by providing a unique identifier from your external system.

Security
API Key
Header parameter nameapi_key
Query parameters
id
stringRequired

The external ID of the subscription to retrieve

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

Results
Array of object (ClubMembership)

See ClubMembership.

object
Id
integer (int32)

The unique identifier of the course.

Example45632
ExternalId
string | null

The course assignment's external ID, usually a unique identifier from the calling system

ExampleE3G5YZFREFEQ9371
ClubId
integer (int32)

The Id of the related subscription profile

Example4421
UserId
integer (int32)

The Id of the related user

Example897615
Starts
integer (int64)

When the subscription starts (in Unix epoch time)

Example1449496800
Expires
integer (int64) | null

When the subscription starts (in Unix epoch time)

Example1450479600
TargetCompletion
integer (int64) | null

When the subscription is expected to be completed by the student (in Unix epoch time)

Example1449874800