---
title: "Get roles on a matter"
method: GET
path: "/matters/{matterId}/roles"
tags: ["Roles"]
---

# Get roles on a matter

`GET /matters/{matterId}/roles`

## Request

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

Returns associated roles for a specified matter.

## Path parameters

- `matterId` string, uuid, required

## Response `200`

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

- MatterRoles
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `versionId` string, nullable: Version id of the record.
  - `matterId` string, nullable: Matter id.
  - `roles` Role[], nullable: List of associated roles.
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
    - `self` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `id` string, nullable: Unique identifier of the role.
    - `name` string, nullable: Name of the role.
    - `contact` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `roleDescription` string, nullable: Name of the role (user editable).
    - `description` string, nullable: Description of the role.
    - `representatives` Link[], nullable: List of hypermedia links of the associated representatives.
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `relationships` Relationship[], nullable: List of associated relationships.
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
      - `self` Link
        - `id` string, nullable
        - `href` string, nullable
        - `relation` string, nullable
        - `method` string, nullable
      - `id` string, nullable: Unique identifier of the relationship.
      - `name` string, nullable: Name of the relationship.
      - `contact` Link
        - `id` string, nullable
        - `href` string, nullable
        - `relation` string, nullable
        - `method` string, nullable
      - `representatives` Link[], nullable: List of hypermedia links of the associated representatives.
        - `id` string, nullable
        - `href` string, nullable
        - `relation` string, nullable
        - `method` string, nullable
    - `isClient` boolean: Boolean flag indicating if role belongs to a 'Client'.
    - `isOtherSide` boolean: Boolean flag indicating if role belongs to an 'OtherSide'.

## Other responses

- `404`: When the specified matter does not exist.

---

[API](https://skmtc.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)