Get matters

curl --request GET \
  --url https://api.smokeball.com/matters \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "externalSystemId": "EXT01",
      "versionId": "637771038395217729",
      "number": "FUS-124",
      "title": "AM-0323-0005 - Smith - Sale - Jones",
      "matterType": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "clients": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "GET"
        }
      ],
      "otherSides": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "GET"
        }
      ],
      "description": "This is a brief description for the matter",
      "status": "Open",
      "personResponsible": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "personAssisting": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "personAssistingStaffs": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "GET"
        }
      ],
      "originatingStaff": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "originatingStaffs": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "GET"
        }
      ],
      "splitOriginatingStaffSettings": {
        "isEnabled": true,
        "splitMatterStaffs": [
          {
            "matterStaffId": "<string>",
            "matterStaffRatio": 123
          }
        ],
        "splitMethod": "<string>",
        "remainderStaffId": "<string>"
      },
      "supervisor": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "clientCode": "Client A",
      "openedDate": "2022-04-23T14:00:00Z",
      "closedDate": "2022-04-23T14:00:00Z",
      "leadOpenedDate": "2022-04-23T14:00:00Z",
      "leadClosedDate": "2022-04-23T14:00:00Z",
      "leadClosedReason": "No longer interested",
      "isLead": false,
      "branch": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "branchProviderId": "Smokeball",
      "referralType": "<string>",
      "referrer": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "referralAgreementFeeType": "<string>",
      "referralAgreementFee": 123,
      "referralAgreementFeeComment": "<string>",
      "items": {},
      "tags": [
        {
          "href": "<string>",
          "relation": "<string>",
          "method": "GET",
          "self": {
            "id": "<string>",
            "href": "<string>",
            "relation": "<string>",
            "method": "GET"
          },
          "id": "a15086f5-4da7-4271-8fea-b24d479ced2b",
          "type": "Staff",
          "name": "",
          "color": "Light Blue",
          "staff": {
            "id": "<string>",
            "href": "<string>",
            "relation": "<string>",
            "method": "GET"
          }
        }
      ]
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  }
}

GET

matters

Get matters

curl --request GET \
  --url https://api.smokeball.com/matters \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "externalSystemId": "EXT01",
      "versionId": "637771038395217729",
      "number": "FUS-124",
      "title": "AM-0323-0005 - Smith - Sale - Jones",
      "matterType": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "clients": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "GET"
        }
      ],
      "otherSides": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "GET"
        }
      ],
      "description": "This is a brief description for the matter",
      "status": "Open",
      "personResponsible": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "personAssisting": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "personAssistingStaffs": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "GET"
        }
      ],
      "originatingStaff": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "originatingStaffs": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "GET"
        }
      ],
      "splitOriginatingStaffSettings": {
        "isEnabled": true,
        "splitMatterStaffs": [
          {
            "matterStaffId": "<string>",
            "matterStaffRatio": 123
          }
        ],
        "splitMethod": "<string>",
        "remainderStaffId": "<string>"
      },
      "supervisor": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "clientCode": "Client A",
      "openedDate": "2022-04-23T14:00:00Z",
      "closedDate": "2022-04-23T14:00:00Z",
      "leadOpenedDate": "2022-04-23T14:00:00Z",
      "leadClosedDate": "2022-04-23T14:00:00Z",
      "leadClosedReason": "No longer interested",
      "isLead": false,
      "branch": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "branchProviderId": "Smokeball",
      "referralType": "<string>",
      "referrer": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "referralAgreementFeeType": "<string>",
      "referralAgreementFee": 123,
      "referralAgreementFeeComment": "<string>",
      "items": {},
      "tags": [
        {
          "href": "<string>",
          "relation": "<string>",
          "method": "GET",
          "self": {
            "id": "<string>",
            "href": "<string>",
            "relation": "<string>",
            "method": "GET"
          },
          "id": "a15086f5-4da7-4271-8fea-b24d479ced2b",
          "type": "Staff",
          "name": "",
          "color": "Light Blue",
          "staff": {
            "id": "<string>",
            "href": "<string>",
            "relation": "<string>",
            "method": "GET"
          }
        }
      ]
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  }
}

Authorizations

x-api-key

string

header

required

Authorization

string

header

required

Query Parameters

Offset

integer<int32>

Required range: 0 <= x <= 2147483647

Limit

integer<int32>

Required range: 1 <= x <= 500

string

Filter matters by specified search term. This field is wide reaching, it is used to search by clients, othersides, description and matter numbers.

Example:

"Bob"

MatterTypeId

string

Filter by matter type identifier.

Example:

"009f778f-83df-454a-b344-768a862a7e55"

ContactId

string

Filter by the contact identifier.

Example:

"7fdbdd5b-0f5e-4095-af9e-ae5b055325c7"

Status

string[]

Filter by current status of the matter.

Possible values: Open, Pending, Closed, Deleted or Cancelled.

IsLead

boolean

Boolean flag to return 'Leads'. This is false by default.

A Lead is a potential matter that has not yet been converted to a full matter. The data structure of a lead is similar to a matter, but with some small variances.

Example:

true

UpdatedSince

integer<int64>

Filter by matters updated since a specified time (.net ticks representation of the UTC datetime). Cannot be used in conjunction with LastUpdated.

This field will not be supported in future, please use LastUpdated instead.

Example:

637873555398585000

LastUpdated

string<date-time>

Filter by last updated date of matter. Cannot be used in conjunction with UpdatedSince.

Example:

"2022-04-23T14:00:00Z"

Sort

string

Available fields: status, lastUpdated

Fields

string

Available fields: items, tags

Response

200 - application/json

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

string | null

href

string | null

relation

string | null

method

string | null

default:GET

self

object

Show child attributes

self.id

string | null

self.href

string | null

self.relation

string | null

self.method

string | null

default:GET

value

object[] | null

Show child attributes

value.href

string | null

value.relation

string | null

value.method

string | null

default:GET

value.self

object

Show child attributes

value.self.id

string | null

value.self.href

string | null

value.self.relation

string | null

value.self.method

string | null

default:GET

value.id

string | null

Unique identifier of the matter.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

value.externalSystemId

string | null

External system id for the matter.

Example:

"EXT01"

value.versionId

string | null

Version id of the record. This can be used in the UpdatedSince query parameter.

Example:

"637771038395217729"

value.number

string | null

Human-friendly number assigned to matter.

Example:

"FUS-124"

value.title

string | null

Title of the matter.

Example:

"AM-0323-0005 - Smith - Sale - Jones"

value.matterType

object

Hypermedia link of the associated matter type.

Show child attributes

value.matterType.id

string | null

value.matterType.href

string | null

value.matterType.relation

string | null

value.matterType.method

string | null

default:GET

value.clients

object[] | null

List of hypermedia links of 'Client' contacts associated with the matter.

Show child attributes

value.clients.id

string | null

value.clients.href

string | null

value.clients.relation

string | null

value.clients.method

string | null

default:GET

value.otherSides

object[] | null

List of hypermedia links of 'OtherSide' contacts associated with the matter.

Show child attributes

value.otherSides.id

string | null

value.otherSides.href

string | null

value.otherSides.relation

string | null

value.otherSides.method

string | null

default:GET

value.description

string | null

Brief description of the matter.

Example:

"This is a brief description for the matter"

value.status

string | null

Current status of the matter.

Possible values: Open, Pending, Closed, Deleted or Cancelled.

Example:

"Open"

value.personResponsible

object

Hypermedia link of the person responsible for the matter (if applicable).

Show child attributes

value.personResponsible.id

string | null

value.personResponsible.href

string | null

value.personResponsible.relation

string | null

value.personResponsible.method

string | null

default:GET

value.personAssisting

object

Hypermedia link of the person assisting in the matter (if applicable).

Show child attributes

value.personAssisting.id

string | null

value.personAssisting.href

string | null

value.personAssisting.relation

string | null

value.personAssisting.method

string | null

default:GET

value.personAssistingStaffs

object[] | null

List of hypermedia links of additional person assisting staff members associated with the matter.

Show child attributes

value.personAssistingStaffs.id

string | null

value.personAssistingStaffs.href

string | null

value.personAssistingStaffs.relation

string | null

value.personAssistingStaffs.method

string | null

default:GET

value.originatingStaff

object

Hypermedia link of the originating attorney (if in US) or introducer (if in AU) of the matter.

Show child attributes

value.originatingStaff.id

string | null

value.originatingStaff.href

string | null

value.originatingStaff.relation

string | null

value.originatingStaff.method

string | null

default:GET

value.originatingStaffs

object[] | null

List of hypermedia links of additional originating (if in US) or introducer (if in AU) staff members associated with the matter.

Show child attributes

value.originatingStaffs.id

string | null

value.originatingStaffs.href

string | null

value.originatingStaffs.relation

string | null

value.originatingStaffs.method

string | null

default:GET

value.splitOriginatingStaffSettings

object

Settings for splitting originating staff members on a matter.

Show child attributes

value.splitOriginatingStaffSettings.isEnabled

boolean

Indicates whether the split matter staff settings are enabled or not.

value.splitOriginatingStaffSettings.splitMatterStaffs

object[] | null

List of staff members involved in the split matter settings.

Show child attributes

value.splitOriginatingStaffSettings.splitMatterStaffs.matterStaffId

string | null

The unique identifier for the split matter staff.

value.splitOriginatingStaffSettings.splitMatterStaffs.matterStaffRatio

integer<int64>

The split ratio for the matter staff.

value.splitOriginatingStaffSettings.splitMethod

string | null

Method used to split the matter staff.

Possible values: Unknown, SplitEvenly, UseRatio.

value.splitOriginatingStaffSettings.remainderStaffId

string | null

The unique identifier for the staff member who will handle the remainder of the matter after the split.

value.supervisor

object

Hypermedia link of the supervisor of the matter.

Only supported in the UK.

Show child attributes

value.supervisor.id

string | null

value.supervisor.href

string | null

value.supervisor.relation

string | null

value.supervisor.method

string | null

default:GET

value.clientCode

string | null

Associates an external client code to this matter.

Only supported in AU and UK.

Example:

"Client A"

value.openedDate

string<date-time> | null

Date the matter was opened.

Example:

"2022-04-23T14:00:00Z"

value.closedDate

string<date-time> | null

Date the matter was closed.

Example:

"2022-04-23T14:00:00Z"

value.leadOpenedDate

string<date-time> | null

Date the lead was opened.

Only applies if isLead is true.

Example:

"2022-04-23T14:00:00Z"

value.leadClosedDate

string<date-time> | null

Date the lead was closed.

Only applies if isLead is true.

Example:

"2022-04-23T14:00:00Z"

value.leadClosedReason

string | null

Reason the lead was closed.

Only applies if isLead is true.

Example:

"No longer interested"

value.isLead

boolean

Boolean flag indicating if the matter is a lead.

Example:

false

value.branch

object

Hypermedia link of the associated branch.

Show child attributes

value.branch.id

string | null

value.branch.href

string | null

value.branch.relation

string | null

value.branch.method

string | null

default:GET

value.branchProviderId

string | null

Unique identifier of the associated branch provider.

Example:

"Smokeball"

value.referralType

string | null

The referral type of the matter.

value.referrer

object

The referrer contact of the matter.

Show child attributes

value.referrer.id

string | null

value.referrer.href

string | null

value.referrer.relation

string | null

value.referrer.method

string | null

default:GET

value.referralAgreementFeeType

string | null

The referral agreement fee type.

value.referralAgreementFee

number<double> | null

The referral agreement fee value.

value.referralAgreementFeeComment

string | null

The referral agreement fee comment.

value.items

object

Items associated with the matter.

Show child attributes

value.items.{key}

object[] | null

Show child attributes

value.items.{key}.type

string | null

Type of the matter item.

Example:

"role or layout"

value.items.{key}.id

string | null

Unique identifier of the matter item.

Example:

"009f778f-83df-454a-b344-768a862a7e55"

value.items.{key}.name

string | null

Name of the matter item as it appears on the matter.

Example:

"Vendor"

value.items.{key}.subItems

object

Subitems associated to the matter item. These items vary depending on the matter.

Show child attributes

value.items.{key}.subItems.{key}

array | null

value.tags

object[] | null

Tags associated with the matter.

Show child attributes

value.tags.href

string | null

value.tags.relation

string | null

value.tags.method

string | null

default:GET

value.tags.self

object

Show child attributes

value.tags.self.id

string | null

value.tags.self.href

string | null

value.tags.self.relation

string | null

value.tags.self.method

string | null

default:GET

value.tags.id

string | null

Unique identifier of the tag.

Example:

"a15086f5-4da7-4271-8fea-b24d479ced2b"

value.tags.type

string

Tag type.

Example:

"Staff"

value.tags.name

string | null

Name of the tag.

Example:

""

value.tags.color

string | null

Color associated with the tag.

Example:

"Light Blue"

value.tags.staff

object

Link to staff.

Show child attributes

value.tags.staff.id

string | null

value.tags.staff.href

string | null

value.tags.staff.relation

string | null

value.tags.staff.method

string | null

default:GET

offset

integer<int32> | null

limit

integer<int32> | null

size

integer<int64>

first

object

Show child attributes

first.id

string | null

first.href

string | null

first.relation

string | null

first.method

string | null

default:GET

object

Show child attributes

previous.id

string | null

previous.href

string | null

previous.relation

string | null

previous.method

string | null

default:GET

object

Show child attributes

next.id

string | null

next.href

string | null

next.relation

string | null

next.method

string | null

default:GET

last

object

Show child attributes

last.id

string | null

last.href

string | null

last.relation

string | null

last.method

string | null

default:GET

Update matter billing configuration Create a matter

⌘I

Documentation

Tutorials

APIs

Get matters

Authorizations

Query Parameters

Response