Skip to main content
GET
/
matters
/
{matterId}
/
items
/
{id}
Get an item on a matter
curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/items/{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",
  "index": 0,
  "visible": false,
  "subItems": "<array>"
}

Authorizations

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

Path Parameters

​
matterId
string
required
​
id
string
required

Response

When request is successful. Returns a 'MatterItem' object.

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

Unique identifier for the item on a matter.

Example:

"009f778f-83df-454a-b344-768a862a7e55"

​
name
string | null

Name of the item.

Example:

"Client"

​
index
integer<int32>

Zero based number of this item in the list.

Example:

0

​
visible
boolean

Boolean flag indicating if the item is visible.

Example:

false

​
subItems
array | null

List of child items associated with the item.