Skip to main content
GET
/
plugins
/
{pluginId}
Get a plugin
curl --request GET \
  --url https://api.smokeball.com/plugins/{pluginId} \
  --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"
  },
  "externalId": "<string>",
  "application": "Native",
  "type": "Button",
  "version": {
    "id": "<string>",
    "pluginId": "<string>",
    "versionNumber": 123,
    "name": "<string>",
    "description": "<string>",
    "placement": "<string>",
    "requestEndpointUrl": "<string>",
    "attributes": {
      "text": "<string>",
      "icon": "<string>",
      "color": "<string>",
      "tooltip": "<string>",
      "page": {
        "title": "<string>",
        "width": 123,
        "height": 123,
        "useDefaultBrowser": true
      }
    },
    "availability": {
      "matterTypeIds": [
        "<string>"
      ]
    },
    "createdDate": "2020-02-15T00:00:00Z",
    "lastUpdatedDate": "2020-02-15T00:00:00Z"
  },
  "lastUpdated": 637847425252027400,
  "createdDate": "2020-02-15T00:00:00Z",
  "lastUpdatedDate": "2020-02-15T00:00:00Z",
  "key": "<string>",
  "additionalData": {}
}

Authorizations

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

Path Parameters

​
pluginId
string<uuid>
required

Response

When request is successful. Returns the plugin.

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
externalId
string | null

Optional id provided by the external system that owns this plugin.

​
application
enum<string>

The application that the plugin should be rendered in.

Available options:
Native,
Web,
Archie
​
type
enum<string>

The type of component the plugin should represent.

Available options:
Button,
Tab
​
version
object

Current version of the plugin.

​
lastUpdated
integer

Last updated timestamp.

Example:

637847425252027400

​
createdDate
string<date-time>

Plugin created date in UTC.

Example:

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

​
lastUpdatedDate
string<date-time>

Plugin last updated date in UTC.

Example:

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

​
key
string | null

Signing key of the plugin to verify integrity of requesting secure URLs.

​
additionalData
object | null

Collection of plugin meta data as KeyValuePair(string, object).