SMsmokeball
Matter Types

Get a matter type

Retrieves a specified matter type.

get/mattertypes/{id}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/mattertypes/{id}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

idstring required

Response

When request is successful. Returns a 'MatterType' object.

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the matter type.

versionIdstring nullable

Version id of the record.

namestring nullable

Name of the matter type.

categorystring nullable

Name of the category to which the matter type belongs.

type0 | 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.

representativeOptionsstring[] nullable

List of possible representative types for the matter type.

locationstring nullable

State to which the matter type belongs.

isDeletedboolean

Returns true if the matter type is deleted.

Deleted matter types cannot be used when creating new leads/matters.

Example response

{
  "id": "009f778f-83df-454a-b344-768a862a7e55",
  "versionId": "832e778f-83df-454a-b344-768a862a7e67",
  "name": "Federal Litigation",
  "category": "Litigation",
  "representativeOptions": [
    "Applicant",
    "Respondent"
  ],
  "location": "Litigation",
  "items": [
    {
      "id": "Plaintiff",
      "providerId": "roles_provider",
      "itemId": "009f778f-83df-454a-b344-768a862a7e55",
      "name": "Claimant"
    }
  ]
}

Changes

No recorded changes to this operation across all 15 revisions of this API.