list-custom-fields
Retrieve the firm's custom field definitions, including IDs, names, field types, owner types, and list options. Use this to map custom data before querying records.
Instructions
List the firm's custom field definitions (id, name, field_type, owner type, list options). Read a record's custom field VALUES by adding 'custom_fields' to the fields parameter of get-matter / get-contact / list-matters.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (Lawmatics returns a fixed 25 records per page). | |
| fields | No | Comma-separated attributes to return, or 'all' for everything. Add 'custom_fields' to include custom field values. | |
| sort_by | No | Attribute to sort by, e.g. 'created_at', 'updated_at', 'id'. Default: id, newest first. | |
| fetch_all | No | Follow pagination and return every record (capped at 1,000). The response says complete=false if truncated. | |
| filter_by | No | Attribute to filter on. IMPORTANT: the Lawmatics API supports only ONE filter per request. Association filters use the _id suffix, e.g. practice_area_id, stage_id, source_id, matter_id, contact_id. | |
| filter_on | No | Value to filter for. Required with filter_by unless filter_with is null/not_null. | |
| sort_order | No | ||
| filter_with | No | Filter operator: =, !=, <, <=, >, >=, like, ilike (default: ilike for text — add % wildcards for fuzzy match, e.g. %smith%), or presence checks: null, not_null. Currency values are in cents. |