# List Sub Statuses

`lawmatics_list-sub-statuses` · Lawmatics MCP tool · Sub Statuses

List matter sub statuses from Lawmatics with optional pagination and sorting. Rows carry a `relationships` envelope with a to-one {id,type} pointer to the creating user; use get-sub-status for the full envelope including the matters (prospects) carrying each sub status.

## Input

- **page** `integer` (> 0) — Page number (1-based)
- **sortBy** `string` (enum: "id", "created_at", "updated_at", "name", "status") — Column to sort by
- **sortOrder** `string` (enum: "asc", "desc") — Sort direction; ascending or descending

## Output

- **subStatuses** `array` (required) — Sub statuses on this page of results
  - **[]** `object`
    - **id** `string` (required) — Lawmatics sub status ID
    - **name** `string` (required) — Sub status name
    - **status** `string` (required) — Matter status this sub status maps to; one of "hired", "pnc", or "lost"
    - **createdAt** `string` (required) — When the sub status was created, as an ISO 8601 timestamp
    - **updatedAt** `string` (required) — When the sub status was last updated, as an ISO 8601 timestamp
    - **relationships** `object` (required) — To-one JSON:API relationship pointers as {id,type} stubs. Not materialized — follow a pointer by calling that resource's own tool (type 'user' -> get-user). List rows carry to-one pointers only; use get-sub-status for the full envelope incl. the to-many `prospects` pointers.
      - **createdBy** `object | null` (required) — Creating user pointer; null when unset
        - **id** `string` (required) — ID of the referenced Lawmatics record
        - **type** `string` (required) — JSON:API record class of the reference (e.g. "user", "contact", "prospect", "firm"); resolve it by calling that resource's own get/find tool — this pointer is not materialized
- **pagination** `object | null` (required) — Pagination metadata from the API response; null when the endpoint returns no meta envelope
  - **totalPages** `number | null` (required) — Total number of pages available; null if not reported
  - **limitPerPage** `number | null` (required) — Maximum sub statuses returned per page; null if not reported
  - **totalEntries** `number | null` (required) — Total number of sub statuses across all pages; null if not reported