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
Matters
Get a matter
Retrieves a specified matter.
GET
/
matters
/
{matterId}
curl --request GET \
--url https://api.smokeball.com/matters/{matterId} \
--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",
"externalSystemId": "EXT01",
"versionId": "637771038395217729",
"number": "FUS-124",
"title": "AM-0323-0005 - Smith - Sale - Jones",
"matterType": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"clients": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
],
"otherSides": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
],
"description": "This is a brief description for the matter",
"status": "Open",
"personResponsible": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"personAssisting": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"originatingStaff": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"supervisor": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"clientCode": "Client A",
"openedDate": "2022-04-23T14:00:00Z",
"closedDate": "2022-04-23T14:00:00Z",
"leadOpenedDate": "2022-04-23T14:00:00Z",
"leadClosedDate": "2022-04-23T14:00:00Z",
"leadClosedReason": "No longer interested",
"isLead": false,
"branch": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"branchProviderId": "Smokeball",
"referralType": "<string>",
"referrer": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"referralAgreementFeeType": "<string>",
"referralAgreementFee": 123,
"referralAgreementFeeComment": "<string>",
"items": {}
}
Path Parameters
Response
200
application/json
When request is successful. Returns a Matter
object.
The response is of type object
.
curl --request GET \
--url https://api.smokeball.com/matters/{matterId} \
--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",
"externalSystemId": "EXT01",
"versionId": "637771038395217729",
"number": "FUS-124",
"title": "AM-0323-0005 - Smith - Sale - Jones",
"matterType": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"clients": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
],
"otherSides": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
],
"description": "This is a brief description for the matter",
"status": "Open",
"personResponsible": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"personAssisting": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"originatingStaff": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"supervisor": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"clientCode": "Client A",
"openedDate": "2022-04-23T14:00:00Z",
"closedDate": "2022-04-23T14:00:00Z",
"leadOpenedDate": "2022-04-23T14:00:00Z",
"leadClosedDate": "2022-04-23T14:00:00Z",
"leadClosedReason": "No longer interested",
"isLead": false,
"branch": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"branchProviderId": "Smokeball",
"referralType": "<string>",
"referrer": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"referralAgreementFeeType": "<string>",
"referralAgreementFee": 123,
"referralAgreementFeeComment": "<string>",
"items": {}
}
Assistant
Responses are generated using AI and may contain mistakes.