Skip to main content

Saved Filters

Create, list, and delete saved filter configurations for reuse. Persist filter conditions, search terms, and sort settings.

Saved filters persist reusable filter configurations so you can apply the same conditions, search terms, and sort settings across multiple sessions. Create a saved filter from any combination of conditions, then reload it later without re-specifying each parameter.

GET/saved-filters

Response (List)

Response fields

dataarrayArray of saved filter objects.
data[].idstringSaved filter UUID.
data[].namestringDisplay name for the saved filter.
data[].conditionsarraySaved filter conditions array.
data[].searchstring | nullSaved free-text search string.
data[].sortobject | nullSaved sort configuration.
data[].source_connection_idstring | nullSource scope if set.
data[].created_atstringISO 8601 creation timestamp.

Response (GET /saved-filters)

{
  "data": [
    {
      "id": "sf_a1b2c3d4",
      "name": "Acme invoices 2024",
      "conditions": [
        { "fieldId": "fld_a1b2c3d4", "operator": "eq", "value": "Acme Corp" }
      ],
      "search": null,
      "sort": { "fieldId": "fld_e5f6g7h8", "direction": "desc" },
      "source_connection_id": null,
      "created_at": "2024-10-01T09:00:00Z"
    }
  ]
}
POST/saved-filters

Response (Create)

Response fields (201 Created)

idstringUUID of the newly created saved filter.
namestringDisplay name.
conditionsarrayPersisted conditions.
searchstring | nullPersisted search string.
sortobject | nullPersisted sort configuration.
source_connection_idstring | nullPersisted source scope.
created_atstringISO 8601 creation timestamp.

Response (POST /saved-filters)

{
  "id": "sf_a1b2c3d4",
  "name": "Acme invoices 2024",
  "conditions": [
    { "fieldId": "fld_a1b2c3d4", "operator": "eq", "value": "Acme Corp" }
  ],
  "search": null,
  "sort": { "fieldId": "fld_e5f6g7h8", "direction": "desc" },
  "source_connection_id": null,
  "created_at": "2024-10-01T09:00:00Z"
}
DELETE/saved-filters/:id

Response (Delete)

Response fields

deletedbooleanAlways true on success.

Response (DELETE /saved-filters/:id)

{ "deleted": true }

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundNo saved filter with this ID exists.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Saved filters work as reusable presets for POST /v1/documents/filter. Store a complex combination of conditions, search text, and sort order once, then load it by ID and pass the saved conditions array directly to the filter endpoint. All team members in the organization can list and use saved filters.

Related

Filter Documents