Skip to main content

Listfilter Model

Overview​

The listfilter table is designed to store filtering preferences and list views for users within a specific application or organization. It tracks user-defined filters, their status, and the applied settings for various lists, enabling custom views and better management of data display based on specific criteria.

Fields​

FieldTypeDescriptionRequired
idstringUnique identifier for the list filter record.❌
listNamestringThe name of the list or view this filter applies to.✅
user_idstringID of the user who created or owns the filter. This allows saving personal filters.✅
application_idstringID of the application where the filter is used.Helps associate the filter with a specific app.❌
org_idstringOrganization ID associated with the filter. Ensures filters are scoped correctly in multi-tenant or org-specific systems.✅
defaultanyBoolean flag indicating if this is the default filter. Could be used to auto-load it.❌
extension_idstringID to link the filter to an extension or plugin feature that augments the base application.❌
object_idstringID of the target object (like a list module or data type) the filter applies to.❌
bundle_idanyID of the associated bundle, if any.❌
overrideanyFlag to determine if the filter overrides existing settings.❌
filtersobjectThe actual filter configuration stored in JSON or serialized format. Includes fields like sort order, conditions, column selection, etc.✅
appliedFilterobjectappliedFilter field❌
listViewstringlistView field✅
created_atdateTimestamp when the filter was created.❌
modified_atdateTimestamp when the filter was last updated.❌

Sample JSON​

{
"id": "example_value",
"listName": "example_value",
"user_id": "example_value",
"application_id": "example_value",
"org_id": "example_value",
"default": "example_value",
"extension_id": "example_value",
"object_id": "example_value",
"bundle_id": "example_value",
"override": "example_value",
"filters": "example_value",
"appliedFilter": "example_value",
"listView": "example_value",
"created_at": "example_value",
"modified_at": "example_value"
}