Skip to main content
GET
/
layouts
/
{id}
Get a layout design
curl --request GET \
  --url https://api.smokeball.com/layouts/{id} \
  --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"
  },
  "versionId": "763c3857-2ed9-4c5d-bee0-c48d48a7543e",
  "name": "Case Details",
  "lastUpdated": 637847425252027400,
  "description": "Property and title details",
  "fields": [
    {
      "name": "PinAndLotSizes[]/AccountNumber",
      "type": "Combobox",
      "possibleValues": [
        "Residence",
        "Commercial",
        "Factory",
        "Office"
      ]
    }
  ]
}

Authorizations

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

Path Parameters

​
id
string
required

Layout design Id

Response

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

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

Version id of the layout design.

Example:

"763c3857-2ed9-4c5d-bee0-c48d48a7543e"

​
name
string | null

Name of the layout design.

Example:

"Case Details"

​
lastUpdated
integer<int64>

Last updated timestamp.

Example:

637847425252027400

​
description
string | null

Brief description of the layout design.

Example:

"Property and title details"

​
fields
object[] | null

Collection of layout design fields.