Sign in

v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
Database table view filters

Creates a new filter for the view related to the provided view_id parameter. When the rows of a view are requested, for example via the list_database_table_grid_view_rows endpoint, then only the rows that apply to all the filters are going to be returned. A filter compares the value of a field to the value of a filter. It depends on the type how values are going to be compared.

post/api/database/views/{view_id}/filters/

Path parameters

view_idinteger required

Creates a filter for the view related to the provided value.

Headers

ClientSessionIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.

ClientUndoRedoActionGroupIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.

Request body

fieldinteger required

The field of which the value must be compared to the filter value.

type'equal' | 'not_equal' | 'filename_contains' | 'files_lower_than' | 'has_file_type' | 'contains' | 'contains_not' | 'contains_word' | 'doesnt_contain_word' | 'starts_with' | 'length_is_lower_than' | 'higher_than' | 'higher_than_or_equal' | 'lower_than' | 'lower_than_or_equal' | 'is_even_and_whole' | 'date_equal' | 'date_before' | 'date_before_or_equal' | 'date_after_days_ago' | 'date_after' | 'date_after_or_equal' | 'date_not_equal' | 'date_equals_today' | 'date_before_today' | 'date_after_today' | 'date_within_days' | 'date_within_weeks' | 'date_within_months' | 'date_equals_days_ago' | 'date_equals_months_ago' | 'date_equals_years_ago' | 'date_equals_week' | 'date_equals_month' | 'date_equals_day_of_month' | 'date_equals_year' | 'date_is' | 'date_is_not' | 'date_is_before' | 'date_is_on_or_before' | 'date_is_after' | 'date_is_on_or_after' | 'date_is_within' | 'single_select_equal' | 'single_select_not_equal' | 'single_select_is_any_of' | 'single_select_is_none_of' | 'link_row_has' | 'link_row_has_not' | 'link_row_contains' | 'link_row_not_contains' | 'boolean' | 'empty' | 'not_empty' | 'multiple_select_has' | 'multiple_select_has_not' | 'multiple_collaborators_has' | 'multiple_collaborators_has_not' | 'user_is' | 'user_is_not' | 'has_value_equal' | 'has_not_value_equal' | 'has_value_contains' | 'has_not_value_contains' | 'has_value_contains_word' | 'has_not_value_contains_word' | 'has_value_length_is_lower_than' | 'has_all_values_equal' | 'has_empty_value' | 'has_not_empty_value' | 'has_any_select_option_equal' | 'has_none_select_option_equal' | 'has_value_lower' | 'has_value_lower_or_equal' | 'has_value_higher' | 'has_value_higher_or_equal' | 'has_not_value_higher_or_equal' | 'has_not_value_higher' | 'has_not_value_lower_or_equal' | 'has_not_value_lower' | 'has_date_equal' | 'has_not_date_equal' | 'has_date_before' | 'has_not_date_before' | 'has_date_on_or_before' | 'has_not_date_on_or_before' | 'has_date_on_or_after' | 'has_not_date_on_or_after' | 'has_date_after' | 'has_not_date_after' | 'has_date_within' | 'has_not_date_within' required
  • equal - equal
  • not_equal - not_equal
  • filename_contains - filename_contains
  • files_lower_than - files_lower_than
  • has_file_type - has_file_type
  • contains - contains
  • contains_not - contains_not
  • contains_word - contains_word
  • doesnt_contain_word - doesnt_contain_word
  • starts_with - starts_with
  • length_is_lower_than - length_is_lower_than
  • higher_than - higher_than
  • higher_than_or_equal - higher_than_or_equal
  • lower_than - lower_than
  • lower_than_or_equal - lower_than_or_equal
  • is_even_and_whole - is_even_and_whole
  • date_equal - date_equal
  • date_before - date_before
  • date_before_or_equal - date_before_or_equal
  • date_after_days_ago - date_after_days_ago
  • date_after - date_after
  • date_after_or_equal - date_after_or_equal
  • date_not_equal - date_not_equal
  • date_equals_today - date_equals_today
  • date_before_today - date_before_today
  • date_after_today - date_after_today
  • date_within_days - date_within_days
  • date_within_weeks - date_within_weeks
  • date_within_months - date_within_months
  • date_equals_days_ago - date_equals_days_ago
  • date_equals_months_ago - date_equals_months_ago
  • date_equals_years_ago - date_equals_years_ago
  • date_equals_week - date_equals_week
  • date_equals_month - date_equals_month
  • date_equals_day_of_month - date_equals_day_of_month
  • date_equals_year - date_equals_year
  • date_is - date_is
  • date_is_not - date_is_not
  • date_is_before - date_is_before
  • date_is_on_or_before - date_is_on_or_before
  • date_is_after - date_is_after
  • date_is_on_or_after - date_is_on_or_after
  • date_is_within - date_is_within
  • single_select_equal - single_select_equal
  • single_select_not_equal - single_select_not_equal
  • single_select_is_any_of - single_select_is_any_of
  • single_select_is_none_of - single_select_is_none_of
  • link_row_has - link_row_has
  • link_row_has_not - link_row_has_not
  • link_row_contains - link_row_contains
  • link_row_not_contains - link_row_not_contains
  • boolean - boolean
  • empty - empty
  • not_empty - not_empty
  • multiple_select_has - multiple_select_has
  • multiple_select_has_not - multiple_select_has_not
  • multiple_collaborators_has - multiple_collaborators_has
  • multiple_collaborators_has_not - multiple_collaborators_has_not
  • user_is - user_is
  • user_is_not - user_is_not
  • has_value_equal - has_value_equal
  • has_not_value_equal - has_not_value_equal
  • has_value_contains - has_value_contains
  • has_not_value_contains - has_not_value_contains
  • has_value_contains_word - has_value_contains_word
  • has_not_value_contains_word - has_not_value_contains_word
  • has_value_length_is_lower_than - has_value_length_is_lower_than
  • has_all_values_equal - has_all_values_equal
  • has_empty_value - has_empty_value
  • has_not_empty_value - has_not_empty_value
  • has_any_select_option_equal - has_any_select_option_equal
  • has_none_select_option_equal - has_none_select_option_equal
  • has_value_lower - has_value_lower
  • has_value_lower_or_equal - has_value_lower_or_equal
  • has_value_higher - has_value_higher
  • has_value_higher_or_equal - has_value_higher_or_equal
  • has_not_value_higher_or_equal - has_not_value_higher_or_equal
  • has_not_value_higher - has_not_value_higher
  • has_not_value_lower_or_equal - has_not_value_lower_or_equal
  • has_not_value_lower - has_not_value_lower
  • has_date_equal - has_date_equal
  • has_not_date_equal - has_not_date_equal
  • has_date_before - has_date_before
  • has_not_date_before - has_not_date_before
  • has_date_on_or_before - has_date_on_or_before
  • has_not_date_on_or_before - has_not_date_on_or_before
  • has_date_on_or_after - has_date_on_or_after
  • has_not_date_on_or_after - has_not_date_on_or_after
  • has_date_after - has_date_after
  • has_not_date_after - has_not_date_after
  • has_date_within - has_date_within
  • has_not_date_within - has_not_date_within
valuestring

The filter value that must be compared to the field's value.

groupinteger nullable

The id of the filter group the new filter will belong to. If this is null, the filter will not be part of a filter group, but directly part of the view.

Response

idinteger required
viewinteger required

The view to which the filter applies. Each view can have his own filters.

fieldinteger required

The field of which the value must be compared to the filter value.

typestring required

Indicates how the field's value must be compared to the filter's value. The filter is always in this order field type value (example: field_1 contains Test).

valuestring

The filter value that must be compared to the field's value.

preload_valuesobject required

Can contain unique preloaded values per filter. This is for example used by the link_row_has filter to communicate the display name if a value is provided.

groupinteger nullable

The id of the filter group this filter belongs to. If this is null, the filter is not part of a filter group.