Saved filters

List your saved filters

GET
/v1/saved-filters

The caller's saved filters (and saved CRM views) in the active organization, oldest first, optionally narrowed by target and kind.

Authorization

x-api-key<token>

In: header

Query Parameters

target?string

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).

Value in"originators" | "agents" | "companies" | "branches" | "offices" | "loans" | "properties" | "sales" | "crm_people" | "crm_companies"
kind?string

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.

Value in"filter" | "view"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/saved-filters"
{
  "data": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "fidelity": "exact",
      "icon": {
        "color": "string",
        "type": "color"
      },
      "id": "string",
      "kind": "filter",
      "name": "string",
      "operationId": "string",
      "query": {
        "property1": null,
        "property2": null
      },
      "queryVersion": 0,
      "stale": true,
      "staleIssues": [
        {
          "message": "string",
          "path": "string"
        }
      ],
      "target": "originators",
      "uiState": {
        "property1": null,
        "property2": null
      },
      "uiStateVersion": 0,
      "unmapped": [
        "string"
      ],
      "updatedAt": "2019-08-24T14:15:22Z",
      "visibility": "private"
    }
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Get a saved filter (with the operation to run it) GET

Returns the saved `query` and the `operationId` to run it with. Check `fidelity` (`partial` → `unmapped` lists what the query omits; `ui_only` → nothing to run) and `stale` (the query no longer validates) before running.

Update a saved filter PATCH

Rename, re-icon, or replace the query / UI state. The target is fixed. A new `query` is validated like on create.