Get layout contacts

Returns a list of contacts on a specified layout.

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

Get layout contacts

cURL

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

200

[
  {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET",
    "self": {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET"
    },
    "key": "",
    "contact": {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET"
    }
  }
]

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

matterId · string<uuid> · required

itemId · string<uuid> · required

Response

200

application/json

When request is successful. Returns a list of 'LayoutContact' objects.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object

Show child attributes

key · string | null

Unique key name for the layout contact.

Example:

""

contact · object

Hypermedia link of the layout contact.

Show child attributes