---
title: "Get layouts"
method: GET
path: "/matters/{matterId}/layouts"
tags: ["Layout Matter Items"]
---

# Get layouts

`GET /matters/{matterId}/layouts`

## Request

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

Returns a collection of layout items on a specified matter.

## Path parameters

- `matterId` string, uuid, required

## Response `200`

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

- LayoutMatterItemDataCollection
  - `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
  - `value` LayoutMatterItem[], nullable
    - `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
    - `name` string, nullable: Name of the layout item.
    - `description` string, nullable: Brief description of the layout item.
    - `itemId` string, uuid: Unique identifier for the layout item.
    - `parentId` string, nullable: Unique identifier for the parent layout design.
    - `index` integer: Zero-based index of the layout item.
    - `parentIndex` integer, nullable: Zero-based index of the parent layout matter item, if one exists.
    - `layoutDesign` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `values` LayoutValue[], nullable: List of layout values.
      - `key` string, nullable
      - `value` string, nullable
      - `state` unknown
    - `events` LayoutEvent[], nullable: List of layout events.
      - `id` string, nullable
      - `appointmentId` string, nullable

---

[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)