--- title: "Retrieve subscription assignment information by external platform ID" slug: "retrieve-subscription-assignment-information-by-external-platform-id-1" updated: 2026-02-10T22:22:09Z published: 2026-02-10T22:22:09Z canonical: "docs.skillable.com/retrieve-subscription-assignment-information-by-external-platform-id-1" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.skillable.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve subscription assignment information by external platform ID Get/GetSubscriptionByExternalId Allows you to get information about a subscription assignment by providing a unique identifier from your external system. SecurityAPI Key: api_keyHeader parameter nameapi_key Query parametersidstringRequired The external ID of the subscription to retrieve Responses200 OK Response Expand Allobject Statusinteger (int32) Indicates the status of the API request. 0 = Success 10 = Error 20 = Not found 30 = Invalid integration key Example10 Errorstring | 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 Idinteger (int32) The unique identifier of the course. Example45632 ExternalIdstring | null The course assignment's external ID, usually a unique identifier from the calling system ExampleE3G5YZFREFEQ9371 ClubIdinteger (int32) The Id of the related subscription profile Example4421 UserIdinteger (int32) The Id of the related user Example897615 Startsinteger (int64) When the subscription starts (in Unix epoch time) Example1449496800 Expiresinteger (int64) | null When the subscription starts (in Unix epoch time) Example1450479600 TargetCompletioninteger (int64) | null When the subscription is expected to be completed by the student (in Unix epoch time) Example1449874800