Model MatchHelp

Saved Filters

List your saved filters

getapi.modelmatch.com/v1/saved-filters

The caller's saved filters (and saved CRM views) in the active organization plus the ones shared with them, oldest first, optionally narrowed by target, kind and ownership. isOwner / permission / canEdit on each row say whose it is and what the caller may do.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

targetenum

Which list the filter runs against. Market targets run against that entity's list operation (see operationId, e.g. listOriginators); crm_people / crm_companies are UI-only (filtered client-side).

Options:originatorsagentscompaniesbranchesofficesloanspropertiessalescrm_peoplecrm_companies
kindenum

filter (default) — a saved search; view — a saved CRM table layout (columns / order) kept in uiState. Views never carry a query and have their own 25-per-target quota. Fixed at create.

Options:filterview
ownershipenum

mine — only filters you own; shared — only filters shared with you. Omit for both.

Options:mineshared

Responses

200objectSaved filters.
Show attributes
dataobject[]required
Show child attributes
canDeletebooleanrequired

You may delete it (owner or workspace admin).

canEditbooleanrequired

You may update its name, icon, query and UI state (owner, editor, or workspace admin).

canManageSharingbooleanrequired

You may change its visibility and who it is shared with (owner or workspace admin).

createdAtdatetimerequired
fidelityenumrequired

How much of the UI state query captures: exact; partial (see unmapped); ui_only — no runnable query. Defaults from whether query is present.

Options:exactpartialui_only
iconobject | nullrequired

Optional marker: one emoji. (Color dots and named icons were retired; existing ones were converted to the nearest emoji.)

Show child attributes
emojistringrequired
typeenumrequired
Options:emoji
idstringrequired
isOwnerbooleanrequired

True for your own filters; false for ones shared with you.

kindenumrequired

filter (default) — a saved search; view — a saved CRM table layout (columns / order) kept in uiState. Views never carry a query and have their own 25-per-target quota. Fixed at create.

Options:filterview
lastUsedAtdatetime | nullrequired

When it was last run; null if never.

namestringrequired
operationIdstring | nullrequired

The operation to run query against (e.g. listOriginators); null for UI-only targets.

ownerNamestring | nullrequired

The owner's display name on a filter shared with you; null on your own filters (and when it cannot be resolved).

ownerUserIdstringrequired

The user who owns it.

permissionenumrequired

Your role: owner, or the access it was shared with you at (editor / viewer; a filter visible to the whole workspace without an editor grant is viewer).

Options:ownereditorviewer
queryobject | nullrequired
Show child attributes
[key: string]null
queryVersionintegerrequired
stalebooleanrequired

True when the stored query no longer validates against the operation (its contract changed). Re-save or adjust before running.

staleIssuesobject[]required
Show child attributes
messagestringrequired
pathstringrequired
targetenumrequired

Which list the filter runs against. Market targets run against that entity's list operation (see operationId, e.g. listOriginators); crm_people / crm_companies are UI-only (filtered client-side).

Options:originatorsagentscompaniesbranchesofficesloanspropertiessalescrm_peoplecrm_companies
uiStateobject | nullrequired
Show child attributes
[key: string]null
uiStateVersionintegerrequired
unmappedstring[]required
updatedAtdatetimerequired
useCountintegerrequired

How many times the filter has been run: fetched with getSavedFilter, or named in X-MM-Saved-Filter-Id on a successful list request (count requests do not count).

visibilityenumrequired

Who can see the filter: private — only its owner; organization — every member of the workspace (view; edit too when orgWidePermission is editor); shared — only the members it was shared with (see /saved-filters/{id}/shares).

Options:privateorganizationshared
400objectValidation error
401objectUnauthorized
403objectForbidden (authenticated, but missing required context — e.g. no active organization)
404objectNot found
413objectResponse payload too large — detail endpoint capped to fit Lambda response limits
503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.