Get matters

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

GET /matters

Get matters

cURL

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

import requests

url = "https://api.smokeball.com/matters"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};

fetch('https://api.smokeball.com/matters', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/matters",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/matters"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.smokeball.com/matters")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/matters")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "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

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 · deprecated

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

Type · string

Type of matter to search for. This is set to Matters 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.

Possible values: "Matters", "Leads", "Matters,Leads".

Example:

"Leads"

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.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object | null

Show child attributes

value · object[] | null

Show child attributes

offset · integer<int32> | null

limit · integer<int32> | null

size · integer<int64>

first · object | null

Show child attributes

previous · object | null

Show child attributes

next · object | null

Show child attributes

last · object | null

Show child attributes