GET https://apis.wso2.com/api/am/publisher/v0.13/subscriptions
This operation can be used to retrieve a list of subscriptions of the user associated with the provided access token. This operation is capable of 1. Retrieving all subscriptions for the user's APIs. `GET https://localhost:9443/api/am/publisher/v0.13/subscriptions` 2. Retrieving subscriptions for a specific API. `GET https://localhost:9443/api/am/publisher/v0.13/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed`
apim:subscription_view
i
GET https://localhost:9443/api/am/publisher/v0.13/subscriptions?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b
Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8
HTTP/1.1 200 OK
Content-Type: application/json
{
"previous": "",
"list": [
{
"subscriptionId": "64eca60b-2e55-4c38-8603-e9e6bad7d809",
"tier": "Gold",
"apiIdentifier": "admin-PhoneVerification-1.0.0",
"applicationId": "896658a0-b4ee-4535-bbfa-806c894a4015",
"status": "UNBLOCKED"
},
{
"subscriptionId": "7ac22c34-8745-4cfe-91e0-262c50b2f2e3",
"tier": "Gold",
"apiIdentifier": "admin-PhoneVerification-1.0.0",
"applicationId": "367a2361-8db5-4140-8133-c6c8dc7fa0c4",
"status": "UNBLOCKED"
}
],
"next": "",
"count": 2
}
curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://localhost:9443/api/am/publisher/v0.13/subscriptions?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b"
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
apiId required |
**API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. |
String | |
Query |
limit optional |
Maximum size of resource array to return. |
Integer |
25 |
Query |
offset optional |
Starting point within the complete list of items qualified. |
Integer |
0 |
Header |
Accept optional |
Media types acceptable for the response. Default is application/json. |
String |
application/json |
Header |
If-None-Match optional |
Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource (Will be supported in future). |
String |
HTTP Code | Description | Schema |
---|---|---|
200 |
OK. Subscription list returned. |
SubscriptionList |
304 |
Not Modified. Empty body because the client has already the latest version of the requested resource (Will be supported in future). |
|
406 |
Not Acceptable. The requested media type is not supported |
Error |