Skip to main content
GET
/
plugins
/
{pluginId}
/
subscriptions
/
{id}
Get a plugin subscription
curl --request GET \
  --url https://api.smokeball.com/plugins/{pluginId}/subscriptions/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.smokeball.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
x-api-key
string
header
required
ā€‹
Authorization
string
header
required

Path Parameters

ā€‹
pluginId
string<uuid>
required
ā€‹
id
string<uuid>
required

Response

When request is successful. Returns a 'PluginSubscription' object.

ā€‹
href
string | null
ā€‹
relation
string | null
ā€‹
method
string | null
default:GET
ā€‹
self
object
ā€‹
id
string | null

Unique identifier of the subscription.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

ā€‹
pluginId
string | null

Unique identifier of the plugin.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

ā€‹
pluginVersionId
string | null

Unique identifier of the plugin version. Can be null.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

ā€‹
createdDate
string<date-time>

Plugin subscription created date in UTC.

Example:

"2020-02-15T00:00:00Z"

ā€‹
lastUpdatedDate
string<date-time>

Plugin subscription last updated date in UTC.

Example:

"2020-02-15T00:00:00Z"

ā€‹
isDisabled
boolean

True when the subscription is disabled (the plugin will not function for the user).