GET
/
mattertypes
curl --request GET \
  --url https://api.smokeball.com/mattertypes \
  --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": "009f778f-83df-454a-b344-768a862a7e55",
      "versionId": "832e778f-83df-454a-b344-768a862a7e67",
      "name": "Federal Litigation",
      "category": "Litigation",
      "type": 0,
      "representativeOptions": [
        "Applicant",
        "Respondent"
      ],
      "location": "Litigation",
      "isDeleted": true
    }
  ],
  "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
​
Name
string

Searches for partial match on matter type name

​
Location
string

Return matter types from a specific location. In the US API this is the ANSI 2 letter state code (e.g. IL, NY). In the AU API this is shorthand state code (e.g. NSW, ACT, etc)

​
Category
string

Return matter types from a specific category.

​
Type
enum<integer>

Return matter types by category type (i.e. MatterType or LeadType).

Possible values: Matter Type = 0, Lead Type = 1. Name of the category type to which the matter type belongs (i.e. MatterType or LeadType).

Possible values: Matter Type = 0, Lead Type = 1.

Available options:
0,
1
Example:

0

Response

200 - application/json

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

The response is of type object.