GET /api/database/views/gallery/{view_id}/

Lists the requested rows of the view's table related to the provided view_id if the authorized user has access to the database's workspace. The response is paginated by a limit/offset style.

Servers

Path parameters

Name Type Required Description
view_id Integer Yes

Returns only rows that belong to the related view's table.

Query parameters

Name Type Required Description
filters String No

A JSON serialized string containing the filter tree to apply to this view. The filter tree is a nested structure containing the filters that need to be applied.

An example of a valid filter tree is the following:{"filter_type": "AND", "filters": [{"field": 1, "type": "equal", "value": "test"}]}. The field value must be the ID of the field to filter on, or the name of the field if user_field_names is true.

The following filters are available: equal, not_equal, filename_contains, files_lower_than, has_file_type, contains, contains_not, contains_word, doesnt_contain_word, 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.

Please note that if this parameter is provided, all other filter__{field}__{filter} will be ignored, as well as the filter_type parameter.

Please note that by passing the filters parameter the view filters saved for the view itself will be ignored.

filter_type String No

AND: Indicates that the rows must match all the provided filters.

OR: Indicates that the rows only have to match one of the filters.

This works only if two or more filters are provided.

Please note that if the filters parameter is provided, this parameter will be ignored.

count Boolean No

If provided only the count will be returned.

limit Integer No

Defines how many rows should be returned.

include String No

A comma separated list allowing the values of field_options and row_metadata which will add the object/objects with the same name to the response if included. The field_options object contains user defined view settings for each field. For example the field's width is included in here. The row_metadata object includes extra row specific data on a per row basis.

exclude_count Boolean No

If provided, the count, previous, and next properties will be excluded from the response. This is useful for large datasets where counting the total number of results is slow.

search String No

If provided only rows with data that matches the search query are going to be returned.

search_mode String No

If provided, allows API consumers to determine what kind of search experience they wish to have. If the default SearchModes.MODE_FT_WITH_COUNT is used, then Postgres full-text search is used. If SearchModes.MODE_COMPAT is provided then the search term will be exactly searched for including whitespace on each cell. This is the Baserow legacy search behaviour.

filter__{field}__{filter} String No

The rows can optionally be filtered by the same view filters available for the views. Multiple filters can be provided if they follow the same format. The field and filter variable indicate how to filter and the value indicates where to filter on.

For example if you provide the following GET parameter filter__field_1__equal=test then only rows where the value of field_1 is equal to test are going to be returned.

The following filters are available: equal, not_equal, filename_contains, files_lower_than, has_file_type, contains, contains_not, contains_word, doesnt_contain_word, 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.

Please note that if the filters parameter is provided, this parameter will be ignored.

Please note that by passing the filter parameters the view filters saved for the view itself will be ignored.

offset Integer No

Can only be used in combination with the limit parameter and defines from which offset the rows should be returned.

order_by String No

Optionally the rows can be ordered by provided field ids separated by comma. By default a field is ordered in ascending (A-Z) order, but by prepending the field with a '-' it can be ordered descending (Z-A).

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.