---
title: "Get a layout design"
method: GET
path: "/layouts/{id}"
tags: ["Layout Designs"]
---

# Get a layout design

`GET /layouts/{id}`

## Request

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

Retrieves a specified layout design.

## Path parameters

- `id` string, required

## Query parameters

- `matterTypeId` string
- `state` string

## Response `200`

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

- LayoutDesign
  - `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 layout design.
  - `name` string, nullable: Name of the layout design.
  - `lastUpdated` integer: Last updated timestamp.
  - `description` string, nullable: Brief description of the layout design.
  - `fields` LayoutDesignField[], nullable: Collection of layout design fields.
    - `name` string, nullable: Name (mapping) of the layout design field.
    - `type` string: Type of the layout design field. Possible values: 'Text','Combobox','Checkbox','Date','Role','Number'. 'Role' type can represent a matter role (for a top-level layout item) or a matter relationship (for a sublayout item).
    - `possibleValues` string[], nullable: List of possible values (e.g. for Combobox field).

## Other responses

- `404`: When layout design 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)