Get a layout

Retrieves a layout item on a specified matter.

GET /matters/{matterId}/layouts/{itemId}

Get a layout

cURL

curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/layouts/{itemId} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.smokeball.com/matters/{matterId}/layouts/{itemId}"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};

fetch('https://api.smokeball.com/matters/{matterId}/layouts/{itemId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/matters/{matterId}/layouts/{itemId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/matters/{matterId}/layouts/{itemId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.smokeball.com/matters/{matterId}/layouts/{itemId}")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/matters/{matterId}/layouts/{itemId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "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,
  "parentIndex": 0,
  "layoutDesign": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "values": [
    {
      "key": "<string>",
      "value": "<string>",
      "state": "<unknown>"
    }
  ],
  "events": [
    {
      "id": "<string>",
      "appointmentId": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<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

200

application/json

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

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object | null

Show child attributes

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

parentIndex · integer<int32> | null

Zero-based index of the parent layout matter item, if one exists.

Example:

0

layoutDesign · object | null

Hypermedia link of the layout design.

Show child attributes

values · object[] | null

List of layout values.

Show child attributes

events · object[] | null

List of layout events.

Show child attributes