---
title: "Get matters"
method: GET
path: "/matters"
tags: ["Matters"]
---

# Get matters

`GET /matters`

## Request

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

Returns a list of matters. To return leads, set the `isLead` search option to true.

## Query parameters

- `Offset` integer
- `Limit` integer
- `Search` string
- `MatterTypeId` string
- `ContactId` string
- `Status` string[]
- `IsLead` boolean
- `Type` string
- `UpdatedSince` integer
- `LastUpdated` string, date-time
- `Sort` string
- `Fields` string

## Response `200`

When request is successful. Returns a paged collection of 'Matter' objects.

- MatterPagedCollection
  - `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
  - `value` Matter[], nullable
    - `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 matter.
    - `externalSystemId` string, nullable: External system id for the matter.
    - `versionId` string, nullable: Version id of the record. This can be used in the UpdatedSince query parameter.
    - `number` string, nullable: Human-friendly number assigned to matter.
    - `title` string, nullable: Title of the matter.
    - `matterType` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `clients` Link[], nullable: List of hypermedia links of 'Client' contacts associated with the matter.
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `otherSides` Link[], nullable: List of hypermedia links of 'OtherSide' contacts associated with the matter.
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `description` string, nullable: Brief description of the matter.
    - `status` string, nullable: Current status of the matter. Possible values: Open, Pending, Closed, Deleted or Cancelled.
    - `personResponsible` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `personAssisting` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `personAssistingStaffs` Link[], nullable: List of hypermedia links of additional person assisting staff members associated with the matter.
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `originatingStaff` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `originatingStaffs` Link[], nullable: List of hypermedia links of additional originating (if in US) or introducer (if in AU) staff members associated with the matter.
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `splitOriginatingStaffSettings` SplitMatterStaffSettings
      - `isEnabled` boolean: Indicates whether the split matter staff settings are enabled or not.
      - `splitMatterStaffs` SplitMatterStaff[], nullable: List of staff members involved in the split matter settings.
        - `matterStaffId` string, nullable: The unique identifier for the split matter staff.
        - `matterStaffRatio` integer: The split ratio for the matter staff.
      - `splitMethod` string, nullable: Method used to split the matter staff. Possible values: Unknown, SplitEvenly, UseRatio.
      - `remainderStaffId` string, nullable: The unique identifier for the staff member who will handle the remainder of the matter after the split.
    - `supervisor` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `clientCode` string, nullable: Associates an external client code to this matter. Only supported in AU and UK.
    - `openedDate` string, date-time, nullable: Date the matter was opened.
    - `closedDate` string, date-time, nullable: Date the matter was closed.
    - `leadOpenedDate` string, date-time, nullable: Date the lead was opened. Only applies if isLead is true.
    - `leadClosedDate` string, date-time, nullable: Date the lead was closed. Only applies if isLead is true.
    - `leadClosedReason` string, nullable: Reason the lead was closed. Only applies if isLead is true.
    - `isLead` boolean: Boolean flag indicating if the matter is a lead.
    - `branch` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `branchProviderId` string, nullable: Unique identifier of the associated branch provider.
    - `referralType` string, nullable: The referral type of the matter.
    - `referrer` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `referralAgreementFeeType` string, nullable: The referral agreement fee type.
    - `referralAgreementFee` number, double, nullable: The referral agreement fee value.
    - `referralAgreementFeeComment` string, nullable: The referral agreement fee comment.
    - `items` object, nullable: Items associated with the matter.
    - `tags` MatterTag[], nullable: Tags associated with the matter.
      - `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 tag.
      - `type` string: Tag type.
      - `name` string, nullable: Name of the tag.
      - `color` string, nullable: Color associated with the tag. Defaults to 'Brown' if not specified.
      - `staff` Link
        - `id` string, nullable
        - `href` string, nullable
        - `relation` string, nullable
        - `method` string, nullable
  - `offset` integer, nullable
  - `limit` integer, nullable
  - `size` integer
  - `first` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `previous` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `next` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `last` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable

---

[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)