GET
/
matters
/
{matterId}
/
layouts
curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/layouts \
  --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"
  },
  "value": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "name": "Item",
      "description": "Text describing item",
      "itemId": "59791902-6280-471b-bd18-f8439ba3042f",
      "parentId": "Client",
      "index": 0,
      "layoutDesign": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "values": [
        {
          "key": "<string>",
          "value": "<string>",
          "state": "<any>"
        }
      ],
      "events": [
        {
          "id": "<string>",
          "appointmentId": "<string>"
        }
      ]
    }
  ]
}

Authorizations

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

Path Parameters

matterId
string
required

Matter Id

Response

200 - application/json

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

The response is of type object.