Subscription (Collection)


Get all subscriptions

GET https://apis.wso2.com/api/am/store/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 applications which are subscibed to a specific API. `GET https://localhost:9443/api/am/store/v0.13/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed` 2. Retrieving APIs which are subscribed by a specific application. `GET https://localhost:9443/api/am/store/v0.13/subscriptions?applicationId=c43a325c-260b-4302-81cb-768eafaa3aed` **IMPORTANT:** * It is mandatory to provide either **apiId** or **applicationId**.

OAuth 2.0 Scope

apim:subscribei

Request

GET https://localhost:9443/api/am/store/v0.13/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8

Response

HTTP/1.1 200 OK Content-Type: application/json { "previous": "", "list": [ { "tier": "Bronze", "subscriptionId": "03b8ef2b-5ae5-41f5-968e-52fa7fbd5d33", "apiIdentifier": "admin-PhoneVerification-2.0.0", "applicationId": "896658a0-b4ee-4535-bbfa-806c894a4015", "status": "UNBLOCKED" }, { "tier": "Bronze", "subscriptionId": "5ed42650-9f5e-4dd4-94f3-3f09f1b17354", "apiIdentifier": "admin-PhoneVerification-2.0.0", "applicationId": "846118a5-3b25-4c22-a983-2d0278936f09", "status": "UNBLOCKED" } ], "count": 2, "next": "" }

Sample CURL

curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://localhost:9443/api/am/store/v0.13/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed"

Parameters

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

applicationId

required

Application Identifier consisting of the UUID of the Application.

String

Query

groupId

optional

Application Group Id

String

Query

offset

optional

Starting point within the complete list of items qualified.

Integer

0

Query

limit

optional

Maximum size of resource array to return.

Integer

25

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.

String

Responses

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