Layout Designs

Get a layout design

Retrieves a specified 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

Path parameters

idstring required

Layout design Id

Query parameters

matterTypeIdstring

Matter type identifier (optional)

statestring

State identifier (optional)

Response

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

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable

versionIdstring nullable

Version id of the layout design.

namestring nullable

Name of the layout design.

lastUpdatedinteger

Last updated timestamp.

descriptionstring nullable

Brief description of the layout design.

Example response

{
  "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"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 15 revisions of this API.