SMsmokeball
Relationships

Get relationship on a role

Returns a relationship with a specified role in a matter.

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

Request

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

Path parameters

matterIdstring uuid required
roleIdstring uuid required
idstring uuid required

Response

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

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the relationship.

namestring nullable

Name of the relationship.

Example response

{
  "id": "009f778f-83df-454a-b344-768a862a7e55",
  "name": "Solicitor"
}

Changes

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