SMsmokeball
Roles

Get role on a matter

Returns a role in a specified matter.

get/matters/{matterId}/roles/{id}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/matters/{matterId}/roles/{id}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

matterIdstring uuid required
idstring uuid required

Response

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

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the role.

namestring nullable

Name of the role.

roleDescriptionstring nullable

Name of the role (user editable).

descriptionstring nullable

Description of the role.

isClientboolean

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

isOtherSideboolean

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

Example response

{
  "id": "009f778f-83df-454a-b344-768a862a7e55",
  "name": "Client",
  "roleDescription": "Head Honcho",
  "description": "The person for whom I am working",
  "relationships": [
    {
      "id": "009f778f-83df-454a-b344-768a862a7e55",
      "name": "Solicitor"
    }
  ]
}

Changes

No recorded changes to this operation across all 15 revisions of this API.