Skip to main content
GET
/
plugins
/
{pluginId}
/
subscriptions
Get plugin subscriptions
curl --request GET \
  --url https://api.smokeball.com/plugins/{pluginId}/subscriptions \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "pluginId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "pluginVersionId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "createdDate": "2020-02-15T00:00:00Z",
      "lastUpdatedDate": "2020-02-15T00:00:00Z",
      "isDisabled": true
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
pluginId
string<uuid>
required

Query Parameters

​
Offset
integer
Required range: 0 <= x <= 2147483647
​
Limit
integer
Required range: 1 <= x <= 500

Response

When request is successful. Returns plugin subscriptions for the account.

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
value
object[] | null
​
offset
integer | null
​
limit
integer | null
​
size
integer
​
first
object
​
previous
object
​
next
object
​
last
object