Saved filters

Update a saved filter

PATCH
/v1/saved-filters/{id}

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

Authorization

x-api-key<token>

In: header

Path Parameters

id*string

Saved-filter id (nanoid).

Match^[\w-]+$
Length1 <= length <= 32

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/saved-filters/V1StGXR8_Z5jdHi6B-myT" \  -H "Content-Type: application/json" \  -d '{}'
{
  "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"
  }
}
{
  "code": "string",
  "error": "string",
  "issues": [
    {
      "message": "string",
      "path": "string"
    }
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "code": "string",
  "error": "string",
  "issues": [
    {
      "message": "string",
      "path": "string"
    }
  ]
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

List your saved filters GET

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

Mint a scoped search token GET

Returns a short-lived scoped search token plus the host to query, so a trusted client can search the entity indexes directly with per-query controls (e.g. attributesToSearchOn for name-only matching).