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": "<string>"
      },
      "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": "<string>"
      },
      "clients": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "<string>"
        }
      ],
      "otherSides": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "<string>"
        }
      ],
      "description": "This is a brief description for the matter",
      "status": "Open",
      "personResponsible": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "personAssisting": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "personAssistingStaffs": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "<string>"
        }
      ],
      "originatingStaff": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "originatingStaffs": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "<string>"
        }
      ],
      "splitOriginatingStaffSettings": {
        "isEnabled": true,
        "splitMatterStaffs": [
          {
            "matterStaffId": "<string>",
            "matterStaffRatio": 123
          }
        ],
        "splitMethod": "<string>",
        "remainderStaffId": "<string>"
      },
      "supervisor": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "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": "<string>"
      },
      "branchProviderId": "Smokeball",
      "referralType": "<string>",
      "referrer": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "referralAgreementFeeType": "<string>",
      "referralAgreementFee": 123,
      "referralAgreementFeeComment": "<string>",
      "items": {},
      "tags": [
        {
          "href": "<string>",
          "relation": "<string>",
          "method": "GET",
          "self": {
            "id": "<string>",
            "href": "<string>",
            "relation": "<string>",
            "method": "<string>"
          },
          "id": "a15086f5-4da7-4271-8fea-b24d479ced2b",
          "type": "Staff",
          "name": "",
          "color": "Light Blue",
          "staff": {
            "id": "<string>",
            "href": "<string>",
            "relation": "<string>",
            "method": "<string>"
          }
        }
      ]
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Query Parameters

​
Offset
integer
Required range: 0 <= x <= 2147483647
​
Limit
integer
Required range: 1 <= x <= 500
​
Search
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 restrict search to 'Leads'.

Example:

true

​
UpdatedSince
integer

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

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.

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
value
object[] | null
​
offset
integer | null
​
limit
integer | null
​
size
integer
​
first
object
​
previous
object
​
next
object
​
last
object