List Sub Statuses (lawmatics_list-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.
Tool Input
pageinteger— Page number (1-based)(> 0)
sortBystring— Column to sort by(enum: "id", "created_at", "updated_at", "name", "status")
sortOrderstring— Sort direction; ascending or descending(enum: "asc", "desc")
Tool Output
subStatusesarrayrequired— Sub statuses on this page of results
[]object
idstringrequired— Lawmatics sub status ID
namestringrequired— Sub status name
statusstringrequired— Matter status this sub status maps to; one of "hired", "pnc", or "lost"
createdAtstringrequired— When the sub status was created, as an ISO 8601 timestamp
updatedAtstringrequired— When the sub status was last updated, as an ISO 8601 timestamp
relationshipsobjectrequired— 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.
1 field
createdByobjectnullrequired— Creating user pointer; null when unset
2 fields
idstringrequired— ID of the referenced Lawmatics record
typestringrequired— 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
paginationobjectnullrequired— Pagination metadata from the API response; null when the endpoint returns no meta envelope
totalPagesnumbernullrequired— Total number of pages available; null if not reported
limitPerPagenumbernullrequired— Maximum sub statuses returned per page; null if not reported
totalEntriesnumbernullrequired— Total number of sub statuses across all pages; null if not reported
Related Tools