Skip to main content
GET
/
matters
/
{matterId}
/
layouts
/
{itemId}
Get a layout
curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/layouts/{itemId} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "name": "Item",
  "description": "Text describing item",
  "itemId": "59791902-6280-471b-bd18-f8439ba3042f",
  "parentId": "Client",
  "index": 0,
  "layoutDesign": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "values": [
    {
      "key": "<string>",
      "value": "<string>",
      "state": "<unknown>"
    }
  ],
  "events": [
    {
      "id": "<string>",
      "appointmentId": "<string>"
    }
  ]
}

Authorizations

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

Path Parameters

​
matterId
string<uuid>
required

Matter Id

​
itemId
string<uuid>
required

Layout item Id

Response

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

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

Name of the layout item.

Example:

"Item"

​
description
string | null

Brief description of the layout item.

Example:

"Text describing item"

​
itemId
string<uuid>

Unique identifier for the layout item.

Example:

"59791902-6280-471b-bd18-f8439ba3042f"

​
parentId
string | null

Unique identifier for the parent layout design.

Example:

"Client"

​
index
integer<int32>

Zero-based index of the layout item.

Example:

0

​
layoutDesign
object

Hypermedia link of the layout design.

​
values
object[] | null

List of layout values.

​
events
object[] | null

List of layout events.