---
title: "Get items on a matter"
method: GET
path: "/matters/{matterId}/items"
tags: ["Matter Items"]
---

# Get items on a matter

`GET /matters/{matterId}/items`

## Request

- Base URL: `https://api.smokeball.com`
- URL: `https://api.smokeball.com/matters/{matterId}/items`
- Auth: API key in header `x-api-key` and API key in header `Authorization`

Returns a list of items on the specified matter.

## Path parameters

- `matterId` string, required

## Response `200`

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

- MatterItems
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `versionId` string, nullable: Version id of the record.
  - `items` MatterItem[], nullable: List of items on a matter.
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
    - `self` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `id` string, nullable: Unique identifier for the item on a matter.
    - `name` string, nullable: Name of the item.
    - `index` integer: Zero based number of this item in the list.
    - `visible` boolean: Boolean flag indicating if the item is visible.
    - `subItems` MatterItem[], nullable: List of child items associated with the item.

## Other responses

- `400`: When an unsupported request is made.
- `403`: When the matter is not associated with the authenticated client.
- `404`: When matter with specified id does not exist.

---

[API](https://skmtc.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)