Get items on a matter

Returns a list of items on the specified matter.

GET /matters/{matterId}/items

Get items on a matter

cURL

curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/items \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

200

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "versionId": "832e778f-83df-454a-b344-768a862a7e67",
  "items": [
    {
      "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

Response

200

application/json

When request is successful. Returns a 'MatterItems' object containing a list of 'MatterItem' objects.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object

Show child attributes

versionId · string | null

Version id of the record.

Example:

"832e778f-83df-454a-b344-768a862a7e67"

items · object[] | null

List of items on a matter.

Show child attributes