List Addresses (lawmatics_list-addresses)
List addresses from Lawmatics with optional pagination, filtering, and sorting. Prefer a filter when possible — the unfiltered firm-wide list is slow and may time out. Filter by addressable_id (the contact/matter/company the address belongs to), addressable_type, label, or created_at. Each row carries a `relationships` envelope with the owning `addressable` record as a to-one {id,type} pointer (a contact, company, matter, event, or the firm itself); use get-address for the full envelope including associated locations.
Tool Input
pageinteger— Page number (1-based)(> 0)
filterobject— Optional single-field filter; one filter at a time
fieldstringrequired— Field to filter on: addressable_id (numeric id of the contact/matter/company the address belongs to), addressable_type (owning record type), label (address label, e.g. Home / Work), or created_at (date)(enum: "addressable_id", "addressable_type", "label", "created_at")
operatorstring— Comparison operator. Omit to use the Lawmatics per-field default (= for ids/dates, ilike for strings). Use = for addressable_id and a range operator (e.g. >) for created_at(enum: "=", "!=", "<", "<=", ">", ">=", "like", "ilike", "null", "not_null")
valuestringrequired— Value to compare against (ignored for null / not_null operators)
sortBystring— Column to sort by(enum: "id", "created_at", "updated_at")
sortOrderstring— Sort direction; ascending or descending(enum: "asc", "desc")
Tool Output
addressesarrayrequired— Addresses on this page of results
[]object
idstringrequired— Unique ID of the address
addressTypestringrequired— Address label (e.g. Home, Work, Mailing)
streetstringrequired— Street address line 1
street2stringnullrequired— Street address line 2 (apt, suite, etc.); null if unset
citystringnullrequired— City; null if unset
statestringnullrequired— State or province; null if unset
postalCodestringnullrequired— Postal/ZIP code; null if unset
countrystringnullrequired— Country; null if unset
fullAddressstringnullrequired— Full formatted single-line address; null if unset
createdAtstringnullrequired— When the address was created, as an ISO 8601 timestamp; null if unknown
updatedAtstringnullrequired— When the address was last updated, as an ISO 8601 timestamp; null if unknown
relationshipsobjectrequired— To-one JSON:API relationship pointers as {id,type} stubs. Not materialized — follow a pointer by calling that resource's own tool. List rows carry the owning `addressable` pointer only; use get-address for the full envelope incl. to-many locations.
1 field
addressableobjectnullrequired— Owning record pointer; null when unlinked. Polymorphic — the `type` is an open string (e.g. "contact", "company", "prospect" for a matter, "registerable_event", "firm"); resolve it by calling that record's own get/find tool
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
limitPerPagenumbernullrequired— Maximum addresses returned per page; null if not reported
totalEntriesnumbernullrequired— Total number of addresses across all pages
Related Tools