Skip to main content
GET
/
matters
/
{matterId}
/
roles
/
{id}
Get role on a matter
curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/roles/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "009f778f-83df-454a-b344-768a862a7e55",
  "name": "Client",
  "contact": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "roleDescription": "Head Honcho",
  "description": "The person for whom I am working",
  "representatives": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET"
    }
  ],
  "relationships": [
    {
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "id": "009f778f-83df-454a-b344-768a862a7e55",
      "name": "Solicitor",
      "contact": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "representatives": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "GET"
        }
      ]
    }
  ],
  "isClient": false,
  "isOtherSide": false
}

Authorizations

ā€‹
x-api-key
string
header
required
ā€‹
Authorization
string
header
required

Path Parameters

ā€‹
matterId
string<uuid>
required
ā€‹
id
string<uuid>
required

Response

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

ā€‹
href
string | null
ā€‹
relation
string | null
ā€‹
method
string | null
default:GET
ā€‹
self
object
ā€‹
id
string | null

Unique identifier of the role.

Example:

"009f778f-83df-454a-b344-768a862a7e55"

ā€‹
name
string | null

Name of the role.

Example:

"Client"

ā€‹
contact
object

Hypermedia link of the associated contact.

ā€‹
roleDescription
string | null

Name of the role (user editable).

Example:

"Head Honcho"

ā€‹
description
string | null

Description of the role.

Example:

"The person for whom I am working"

ā€‹
representatives
object[] | null

List of hypermedia links of the associated representatives.

ā€‹
relationships
object[] | null

List of associated relationships.

ā€‹
isClient
boolean

Boolean flag indicating if role belongs to a 'Client'.

Example:

false

ā€‹
isOtherSide
boolean

Boolean flag indicating if role belongs to an 'OtherSide'.

Example:

false