Documentation
- Getting Started
- Authentication
- Making Requests
- Resource Creation
- Searching
- Plugins
- Webhooks
Tutorials
APIs
- Activity Codes
- Archive
- Authorization
- Bank Accounts
- Contacts
- Events
- Expenses
- Fees
- Files
- Firm
- Firm Users
- Folders
- Invoices
- Layout Designs
- Layout Matter Items
- Matter Billing Configuration
- Matter Items
- Matter Types
- Matters
- Memos
- Notifications
- Plugins
- Referral Types
- Relationships
- Roles
- Staff
- Stages
- Subscription Payments
- Subscription Promotions
- Subscriptions
- Tasks
- Users
- Webhooks
Plugins
Get plugins
Returns existing plugins.
GET
/
plugins
curl --request GET \
--url https://api.smokeball.com/plugins \
--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": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"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": {}
}
],
"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>"
}
}
Query Parameters
Required range:
0 <= x <= 2147483647
Required range:
1 <= x <= 500
Response
200 - application/json
When request is successful. Returns existing plugins.
The response is of type object
.
curl --request GET \
--url https://api.smokeball.com/plugins \
--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": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"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": {}
}
],
"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>"
}
}