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": "<string>"
  },
  "representatives": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "<string>"
    }
  ],
  "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>"
        }
      ]
    }
  ],
  "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.

​
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

⌘I