v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Matter Types

Get matter types

Returns a paginated list of matter types based on search criteria. Deleted matter types are not included.

Note: If no Location is provided, all matter types from all locations will be returned.

get/mattertypes

Query parameters

Offsetinteger
Limitinteger
Namestring

Searches for partial match on matter type name

Locationstring

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)

Categorystring

Return matter types from a specific category.

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.

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

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

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
offsetinteger nullable
limitinteger nullable
sizeinteger

Example response

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