v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Roles

Get roles on a matter

Returns associated roles for a specified matter.

get/matters/{matterId}/roles

Path parameters

matterIdstring uuid required

Response

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

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable

versionIdstring nullable

Version id of the record.

matterIdstring nullable

Matter id.

Example response

{
  "versionId": "832e778f-83df-454a-b344-768a862a7e67",
  "matterId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "roles": [
    {
      "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"
        }
      ]
    }
  ]
}