Responds with serialized rows grouped by the view's single select field options if the user is authenticated and has access to the related workspace. Additional query parameters can be provided to control the limit and offset per select option.
This is a premium feature.
Path parameters
Returns only rows that belong to the related view's table.
Query parameters
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, 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.
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.
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.
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, 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.
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.
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.
Defines how many rows should be returned by default. This value can be overwritten per select option.
if provided, the maximum number of relationships per link row field in the response. If not provided, all the relationships will be returned.
Defines from which offset the rows should be returned.This value can be overwritten per select option.
Accepts multiple select_option parameters. If not provided, the rows of all select options will be returned. If one or more select_option parameters are provided, then only the rows of those will be included in the response. ?select_option=1&select_option=null will only include the rows for both select option with id 1 and null. ?select_option=1,10,20 will only include the rows of select option id 1 with a limit of 10 and and offset of 20.