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
Roles
Get role on a matter
Returns a role in a specified matter.
GET
/
matters
/
{matterId}
/
roles
/
{id}
curl --request GET \
--url https://api.smokeball.com/matters/{matterId}/roles/{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": "009f778f-83df-454a-b344-768a862a7e55",
"name": "Client",
"contact": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"representatives": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
],
"relationships": [
{
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"id": "009f778f-83df-454a-b344-768a862a7e55",
"name": "Solicitor",
"contact": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"representatives": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
]
}
],
"isClient": false,
"isOtherSide": false
}
Response
200
application/json
When request is successful. Returns a 'Role' object.
The response is of type object
.
curl --request GET \
--url https://api.smokeball.com/matters/{matterId}/roles/{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": "009f778f-83df-454a-b344-768a862a7e55",
"name": "Client",
"contact": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"representatives": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
],
"relationships": [
{
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"id": "009f778f-83df-454a-b344-768a862a7e55",
"name": "Solicitor",
"contact": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"representatives": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
}
]
}
],
"isClient": false,
"isOtherSide": false
}