Get role on a matter

Returns a role in a specified matter.

GET /matters/{matterId}/roles/{id}

Get role on a matter

cURL

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

import requests

url = "https://api.smokeball.com/matters/{matterId}/roles/{id}"

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}/roles/{id}', 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}/roles/{id}",
  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}/roles/{id}"

	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}/roles/{id}")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "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
}

{
  "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

id · string<uuid> · required

Response

200

application/json

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

href · string | null

relation · string | null

method · string | null · default: GET

self · object | null

Show child attributes

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 | null

Hypermedia link of the associated contact.

Show child attributes

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.

Show child attributes

relationships · object[] | null

List of associated relationships.

Show child attributes

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