---
title: "Get matter types"
method: GET
path: "/mattertypes"
tags: ["Matter Types"]
---

# Get matter types

`GET /mattertypes`

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.

## Query parameters

- `Offset` integer
- `Limit` integer
- `Name` string
- `Location` string
- `Category` string
- `Type` 0 | 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.

## Response `200`

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

- MatterTypeInfoPagedCollection
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `value` MatterTypeInfo[], nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
    - `self` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `id` string, nullable — Unique identifier of the matter type.
    - `versionId` string, nullable — Version id of the record.
    - `name` string, nullable — Name of the matter type.
    - `category` string, nullable — Name of the category to which the matter type belongs.
    - `type` 0 | 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.
    - `representativeOptions` string[], nullable — List of possible representative types for the matter type.
    - `location` string, nullable — State to which the matter type belongs.
    - `isDeleted` boolean — Returns true if the matter type is deleted. Deleted matter types cannot be used when creating new leads/matters.
  - `offset` integer, nullable
  - `limit` integer, nullable
  - `size` integer
  - `first` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `previous` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `next` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `last` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable

## Other responses

- `400` — When an unsupported request is made.

---

[API](https://skmtc.net/smokeball/apis/api.md) · [All operations](https://skmtc.net/smokeball/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smokeball/api/revisions/197984da9b42/schema)