GET
/
matters
/
{matterId}
/
roles
/
{roleId}
/
relationships
Get relationships on a matter
curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/roles/{roleId}/relationships \
  --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": "832e778f-83df-454a-b344-768a862a7e67",
  "relationships": [
    {
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "id": "009f778f-83df-454a-b344-768a862a7e55",
      "name": "Solicitor",
      "contact": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "representatives": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "<string>"
        }
      ]
    }
  ]
}

Authorizations

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

Path Parameters

​
matterId
string<uuid>
required
​
roleId
string<uuid>
required

Response

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

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

Version id of the record.

Example:

"832e778f-83df-454a-b344-768a862a7e67"

​
relationships
object[] | null

List of associated relationships.