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 plugin subscriptions
Returns plugin subscriptions for the account.
GET
/
plugins
/
{pluginId}
/
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>"
}
}
Path Parameters
Query Parameters
Required range:
0 <= x <= 2147483647
Required range:
1 <= x <= 500
Response
200
application/json
When request is successful. Returns plugin subscriptions for the account.
The response is of type object
.
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>"
}
}