Skip to content

Notion: Views schemas

52 Notion schemas with complete fields and constraints.

← Views operations · All schemas

Create a view query — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
page_sizeintegerOptionalThe number of results to return per page. Maximum: 100
Maximum: 100
Minimum: 1

Create a view query — response body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
expires_atstringRequired within parentWhen the cached query results expire.
Format: date-time
has_morebooleanRequired within parentWhether there are more results.
idstringRequired within parentThe query ID.
Format: uuid
next_cursorJSONRequired within parentCursor for the next page of results.
next_cursor (anyOf 1)stringAlternativeFormat: uuid
next_cursor (anyOf 2)nullAlternative
objectstringRequired within parentThe object type.
Must equal: view_query
request_statusModelOptionalExpand List views — response body — request status
Set to `{ type: 'incomplete', incomplete_reason: 'query_result_limit_reached' }` when the view's underlying data source has more rows matching this query than the server-side pagination depth limit allows.
resultsarrayRequired within parentThe page results for this page.
Maximum items: 100
results[]ModelEach itemExpand Create a view query — response body — results item
total_countJSONRequired within parent
total_count (anyOf 1)numberAlternativeTotal number of results in the query.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
view_idstringRequired within parentThe view this query was executed against.
Format: uuid

Referenced models: Create a view query — response body — results item, List views — response body — request status

Create a view query — response body — results item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe object ID.
Format: uuid
objectstringRequired within parentThe object type.

Delete a view query — response body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
deletedbooleanRequired within parentWhether the view query was deleted.
idstringRequired within parentThe ID of the deleted view query.
Format: uuid
objectstringRequired within parentThe object type.
Must equal: view_query

Delete a view — response body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe ID of the view.
Format: uuid
objectstringRequired within parentThe object type name.
Must equal: view
parentModelRequired within parentExpand Delete a view — response body — parent
The parent database of the view.
typestringRequired within parentThe view type.
Known values: table, board, list, calendar, timeline, gallery, form, chart, map, dashboard

Referenced models: Delete a view — response body — parent

Delete a view — response body — parent

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
database_idstringRequired within parentThe ID of the parent database.
Format: uuid
typestringRequired within parentThe parent type.
Must equal: database_id

List views — response body — request status

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
incomplete_reasonstringOptionalWhy the result set is incomplete. Only present when `type` is `incomplete`.
Must equal: query_result_limit_reached
typestringRequired within parentWhether the result set is complete or incomplete. `incomplete` means the response does not include all rows that match the query parameters (e.g. due to a server-side pagination depth limit).
Known values: complete, incomplete

List views — response body — results item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe ID of the view.
Format: uuid
objectstringRequired within parentThe object type name.
Must equal: view

List views — response body — view

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed

Retrieve a view — response body — object view

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
configurationJSONOptionalView presentation configuration.
configuration (anyOf 1)ModelAlternativeExpand Retrieve a view — response body — object view configuration value
configuration (anyOf 2)nullAlternative
created_byJSONOptionalThe user who created the view, or null if not available.
created_by (anyOf 1)ModelAlternativeExpand Update page — response body — object page created by
created_by (anyOf 2)nullAlternative
created_timestringRequired within parentThe time when the view was created.
Format: date-time
dashboard_view_idstringOptionalFor dashboard widget views, the ID of the parent dashboard view. Only present when this view is a widget inside a dashboard.
data_source_idJSONOptionalThe ID of the data source this view is scoped to, or null for dashboard views.
data_source_id (anyOf 1)stringAlternative
data_source_id (anyOf 2)nullAlternative
filterJSONOptionalThe filter applied to this view (same shape as data source query filter).
filter (anyOf 1)ModelAlternativeExpand Retrieve a view — response body — object view filter value
filter (anyOf 2)nullAlternative
idstringRequired within parentThe ID of the view.
Format: uuid
last_edited_byJSONOptionalThe user who last edited the view, or null if not available.
last_edited_by (anyOf 1)ModelAlternativeExpand Update page — response body — object page created by
last_edited_by (anyOf 2)nullAlternative
last_edited_timestringRequired within parentThe time when the view was last edited.
Format: date-time
namestringRequired within parentThe name of the view.
objectstringRequired within parentThe object type name.
Must equal: view
parentModelRequired within parentExpand Delete a view — response body — parent
The parent database of the view.
quick_filtersJSONOptionalQuick filters pinned to the view's filter bar. Keys are property IDs. Values are filter conditions (same shape as a property filter without the property field). Null when no quick filters are set.
quick_filters (anyOf 1)objectAlternativeAdditional keys: see wildcard field
quick_filters (anyOf 1).*ModelAdditional keysExpand Retrieve a view — response body — object view quick filters object value
quick_filters (anyOf 2)nullAlternative
sortsJSONOptionalThe sorts applied to this view (same shape as data source query sorts).
sorts (anyOf 1)arrayAlternativeMaximum items: 100
sorts (anyOf 1)[]ModelEach itemExpand Retrieve a view — response body — object view sorts array item
sorts (anyOf 2)nullAlternative
typestringRequired within parentThe view type.
Known values: table, board, list, calendar, timeline, gallery, form, chart, map, dashboard
urlstringRequired within parentCanonical deep link to the view in Notion.

Referenced models: Delete a view — response body — parent, Update page — response body — object page created by, Retrieve a view — response body — object view quick filters object value, Retrieve a view — response body — object view configuration value, Retrieve a view — response body — object view filter value, Retrieve a view — response body — object view sorts array item

Retrieve a view — response body — object view / configuration / value / axis_labels: none, x axis, y axis, both, chart type: column, bar, line, donut, number, donut labels: none, value, name, name and value, grid lines: none, horizontal, vertical, both, group style: normal, percent, side by side, height: small, medium, large, extra large, legend position: off, bottom, side, sort: manual, x ascending, x descending, y ascending, y descending, type chart

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
axis_labelsstringOptionalWhich axis labels to display.
Known values: none, x_axis, y_axis, both
captionJSONOptionalText caption displayed below the chart. Null when no caption is shown.
caption (anyOf 1)stringAlternative
caption (anyOf 2)nullAlternative
chart_typestringRequired within parentThe chart type: column (vertical bars), bar (horizontal bars), line, donut, or number (single value display).
Known values: column, bar, line, donut, number
color_by_valuebooleanOptionalWhether chart elements are colored by their numeric value (gradient coloring).
color_themestringOptionalColor theme for the chart.
Known values: gray, blue, yellow, green, purple, teal, orange, pink, red, auto, colorful
cumulativebooleanOptionalWhether to show cumulative values (line charts only).
donut_labelsstringOptionalWhat to display on donut chart slices.
Known values: none, value, name, name_and_value
grid_linesstringOptionalWhich grid lines to display.
Known values: none, horizontal, vertical, both
group_stylestringOptionalHow grouped/stacked bars are displayed. "normal" stacks values, "percent" normalizes to 100%, "side_by_side" places bars next to each other.
Known values: normal, percent, side_by_side
heightstringOptionalChart height.
Known values: small, medium, large, extra_large
hide_empty_groupsbooleanOptionalWhether to hide groups with no data on the x-axis.
hide_line_fill_areabooleanOptionalWhether to hide the shaded area under the line (line charts only).
hide_titlebooleanOptionalWhether to hide the title label (number charts only).
legend_positionstringOptionalLegend display position. "off" hides the legend.
Known values: off, bottom, side
reference_linesJSONOptionalReference lines drawn on the chart. Null when no reference lines are configured.
reference_lines (anyOf 1)arrayAlternativeMaximum items: 100
reference_lines (anyOf 1)[]ModelEach itemExpand Retrieve a view — response body — object view / configuration / value / axis_labels: none, x axis, y axis, both, chart type: column, bar, line, donut, number, donut labels: none, value, name, name and value, grid lines: none, horizontal, vertical, both, group style: normal, percent, side by side, height: small, medium, large, extra large, legend position: off, bottom, side, sort: manual, x ascending, x descending, y ascending, y descending, type chart reference lines array item
reference_lines (anyOf 2)nullAlternative
show_data_labelsbooleanOptionalWhether to show data value labels on chart elements.
smooth_linebooleanOptionalWhether to use smooth curves (line charts only).
sortstringOptionalSort order for chart data.
Known values: manual, x_ascending, x_descending, y_ascending, y_descending
stack_byJSONOptionalStack-by grouping configuration for stacked/grouped bar charts (column/bar/line only). Null when not stacked.
stack_by (anyOf 1)ModelAlternativeExpand Retrieve a view — response body — object view configuration value type table group by
stack_by (anyOf 2)nullAlternative
typestringRequired within parentThe view configuration type.
Must equal: chart
valueModelOptionalExpand Retrieve a view — response body — object view / configuration / value / axis_labels: none, x axis, y axis, both, chart type: column, bar, line, donut, number, donut labels: none, value, name, name and value, grid lines: none, horizontal, vertical, both, group style: normal, percent, side by side, height: small, medium, large, extra large, legend position: off, bottom, side, sort: manual, x ascending, x descending, y ascending, y descending, type chart value
Aggregation configuration for number charts (single value display).
x_axisJSONOptionalX-axis grouping configuration for column/bar/line/donut charts using grouped data. Null when using results (raw property values) mode.
x_axis (anyOf 1)ModelAlternativeExpand Retrieve a view — response body — object view configuration value type table group by
x_axis (anyOf 2)nullAlternative
x_axis_property_idstringOptionalProperty ID for the x-axis name values when using results (raw property values) mode.
y_axisJSONOptionalY-axis aggregation for column/bar/line/donut charts using grouped data. Null when using results mode.
y_axis (anyOf 1)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / axis_labels: none, x axis, y axis, both, chart type: column, bar, line, donut, number, donut labels: none, value, name, name and value, grid lines: none, horizontal, vertical, both, group style: normal, percent, side by side, height: small, medium, large, extra large, legend position: off, bottom, side, sort: manual, x ascending, x descending, y ascending, y descending, type chart value
y_axis (anyOf 2)nullAlternative
y_axis_maxJSONOptionalCustom maximum value for the y-axis. Null clears the override.
y_axis_max (anyOf 1)JSONAlternative
y_axis_max (anyOf 1) (anyOf 1)numberAlternative
y_axis_max (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
y_axis_max (anyOf 2)nullAlternative
y_axis_minJSONOptionalCustom minimum value for the y-axis. Null clears the override.
y_axis_min (anyOf 1)JSONAlternative
y_axis_min (anyOf 1) (anyOf 1)numberAlternative
y_axis_min (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
y_axis_min (anyOf 2)nullAlternative
y_axis_property_idstringOptionalProperty ID for the y-axis numeric values when using results (raw property values) mode.

Referenced models: Retrieve a view — response body — object view / configuration / value / axis_labels: none, x axis, y axis, both, chart type: column, bar, line, donut, number, donut labels: none, value, name, name and value, grid lines: none, horizontal, vertical, both, group style: normal, percent, side by side, height: small, medium, large, extra large, legend position: off, bottom, side, sort: manual, x ascending, x descending, y ascending, y descending, type chart value, Retrieve a view — response body — object view / configuration / value / axis_labels: none, x axis, y axis, both, chart type: column, bar, line, donut, number, donut labels: none, value, name, name and value, grid lines: none, horizontal, vertical, both, group style: normal, percent, side by side, height: small, medium, large, extra large, legend position: off, bottom, side, sort: manual, x ascending, x descending, y ascending, y descending, type chart reference lines array item, Retrieve a view — response body — object view configuration value type table group by

Retrieve a view — response body — object view / configuration / value / axis_labels: none, x axis, y axis, both, chart type: column, bar, line, donut, number, donut labels: none, value, name, name and value, grid lines: none, horizontal, vertical, both, group style: normal, percent, side by side, height: small, medium, large, extra large, legend position: off, bottom, side, sort: manual, x ascending, x descending, y ascending, y descending, type chart reference lines array item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
colorstringRequired within parentColor of the reference line.
Known values: gray, lightgray, brown, yellow, orange, green, blue, purple, pink, red
dash_stylestringRequired within parentLine style: "solid" for a continuous line, "dash" for a dashed line.
Known values: solid, dash
idstringRequired within parentUnique identifier for the reference line.
labelstringRequired within parentLabel displayed alongside the reference line.
valueJSONRequired within parent
value (anyOf 1)numberAlternativeThe y-axis value where the reference line is drawn.
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a view — response body — object view / configuration / value / axis_labels: none, x axis, y axis, both, chart type: column, bar, line, donut, number, donut labels: none, value, name, name and value, grid lines: none, horizontal, vertical, both, group style: normal, percent, side by side, height: small, medium, large, extra large, legend position: off, bottom, side, sort: manual, x ascending, x descending, y ascending, y descending, type chart value

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
aggregatorstringRequired within parentThe aggregation operator. "count" counts all rows and does not require a property_id. All other operators require a property_id.
Known values: count, count_values, sum, average, median, min, max, range, unique, empty, not_empty, percent_empty, percent_not_empty, checked, unchecked, percent_checked, percent_unchecked, earliest_date, latest_date, date_range
property_idstringOptionalThe property to aggregate on. Required for all operators except "count".

Retrieve a view — response body — object view / configuration / value / card_layout: list, compact, cover aspect: contain, cover, cover size: small, medium, large, type board

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
card_layoutstringOptionalCard layout mode (list shows all properties, compact shows inline).
Known values: list, compact
coverModelOptionalExpand Retrieve a view — response body — object view / configuration / value / card_layout: list, compact, cover aspect: contain, cover, cover size: small, medium, large, type board cover
Card cover/preview image configuration.
cover_aspectstringOptionalCover image aspect ratio.
Known values: contain, cover
cover_sizestringOptionalCover image size.
Known values: small, medium, large
group_byModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by
Column (horizontal) grouping - required for board view.
propertiesarrayOptionalProperties to display on each card.
Maximum items: 100
properties[]ModelEach itemExpand Retrieve a view — response body — object view configuration value type list properties item
sub_group_byModelOptionalExpand Retrieve a view — response body — object view configuration value type table group by
Sub-grouping (vertical swimlanes within columns).
typestringRequired within parentThe view configuration type.
Must equal: board

Referenced models: Retrieve a view — response body — object view / configuration / value / card_layout: list, compact, cover aspect: contain, cover, cover size: small, medium, large, type board cover, Retrieve a view — response body — object view configuration value type table group by, Retrieve a view — response body — object view configuration value type list properties item

Retrieve a view — response body — object view / configuration / value / card_layout: list, compact, cover aspect: contain, cover, cover size: small, medium, large, type board cover

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
property_idstringOptionalProperty ID when type is "property".
typestringRequired within parentSource of the cover image.
Known values: page_cover, page_content, page_content_first, property

Retrieve a view — response body — object view / configuration / value / card_layout: list, compact, cover aspect: contain, cover, cover size: small, medium, large, type gallery

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
card_layoutstringOptionalCard layout mode (list shows all properties, compact shows inline).
Known values: list, compact
coverModelOptionalExpand Retrieve a view — response body — object view / configuration / value / card_layout: list, compact, cover aspect: contain, cover, cover size: small, medium, large, type board cover
Card cover/preview image configuration.
cover_aspectstringOptionalCover image aspect ratio.
Known values: contain, cover
cover_sizestringOptionalCover image size.
Known values: small, medium, large
propertiesarrayOptionalProperties to display on gallery cards.
Maximum items: 100
properties[]ModelEach itemExpand Retrieve a view — response body — object view configuration value type list properties item
typestringRequired within parentThe view configuration type.
Must equal: gallery

Referenced models: Retrieve a view — response body — object view / configuration / value / card_layout: list, compact, cover aspect: contain, cover, cover size: small, medium, large, type board cover, Retrieve a view — response body — object view configuration value type list properties item

Retrieve a view — response body — object view / configuration / value / height: small, medium, large, extra large, type map

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
heightstringOptionalMap display height.
Known values: small, medium, large, extra_large
map_bystringOptionalProperty ID of the location property used to position items on the map.
map_by_property_namestringOptionalMap-by property name (convenience field).
propertiesarrayOptionalProperties to display on map pin cards.
Maximum items: 100
properties[]ModelEach itemExpand Retrieve a view — response body — object view configuration value type list properties item
typestringRequired within parentThe view configuration type.
Must equal: map

Referenced models: Retrieve a view — response body — object view configuration value type list properties item

Retrieve a view — response body — object view / configuration / value / submission_permissions: none, comment only, reader, read and write, editor, type form

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
anonymous_submissionsbooleanOptionalWhether anonymous (non-logged-in) submissions are allowed.
is_form_closedbooleanOptionalWhether the form is closed for submissions.
submission_permissionsstringOptionalPermission level granted to the submitter on the created page after form submission.
Known values: none, comment_only, reader, read_and_write, editor
typestringRequired within parentThe view configuration type.
Must equal: form

Retrieve a view — response body — object view / configuration / value / type calendar, view_range: week, month

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
date_property_idstringRequired within parentDate property used to position items on the calendar - required.
date_property_namestringOptionalDate property name (convenience field).
propertiesarrayOptionalProperties to display on calendar event cards.
Maximum items: 100
properties[]ModelEach itemExpand Retrieve a view — response body — object view configuration value type list properties item
show_weekendsbooleanOptionalWhether to show weekend days.
typestringRequired within parentThe view configuration type.
Must equal: calendar
view_rangestringOptionalCalendar view range.
Known values: week, month

Referenced models: Retrieve a view — response body — object view configuration value type list properties item

Retrieve a view — response body — object view / configuration / value / type table / group_by / group_by: exact, alphabet prefix, type: text, title, url, email, phone number

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
group_bystringRequired within parentHow to group text values. "exact" = exact match, "alphabet_prefix" = first letter.
Known values: exact, alphabet_prefix
hide_empty_groupsbooleanOptionalWhether to hide groups that have no items.
property_idstringRequired within parentProperty ID to group by.
property_namestringOptionalProperty name (convenience field).
sortModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by type number sort
Sort order for groups.
typestringRequired within parentThe property type for grouping.
Known values: text, title, url, email, phone_number

Referenced models: Retrieve a view — response body — object view configuration value type table group by type number sort

Retrieve a view — response body — object view / configuration / value / type table / group_by / group_by: group, option, type status

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
group_bystringRequired within parentHow to group status values. "group" groups by status group (To Do/In Progress/Done), "option" groups by individual option.
Known values: group, option
hide_empty_groupsbooleanOptionalWhether to hide groups that have no items.
property_idstringRequired within parentProperty ID to group by.
property_namestringOptionalProperty name (convenience field).
sortModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by type number sort
Sort order for groups.
typestringRequired within parentThe property type for grouping.
Must equal: status

Referenced models: Retrieve a view — response body — object view configuration value type table group by type number sort

Retrieve a view — response body — object view / configuration / value / type table / group_by / group_by: relative, day, week, month, year, type: date, created time, last edited time

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
group_bystringRequired within parentGranularity for date grouping.
Known values: relative, day, week, month, year
hide_empty_groupsbooleanOptionalWhether to hide groups that have no items.
property_idstringRequired within parentProperty ID to group by.
property_namestringOptionalProperty name (convenience field).
sortModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by type number sort
Sort order for groups (no manual sort for dates).
start_day_of_weekJSONOptional
start_day_of_week (anyOf 1)numberAlternativeStart day of week for week grouping (0 = Sunday, 1 = Monday).
Known values: 0, 1
start_day_of_week (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
typestringRequired within parentThe property type for grouping.
Known values: date, created_time, last_edited_time

Referenced models: Retrieve a view — response body — object view configuration value type table group by type number sort

Retrieve a view — response body — object view / configuration / value / type table / group_by / type formula / group_by / group_by: exact, alphabet prefix, type text

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
group_bystringRequired within parentHow to group text values. "exact" = exact match, "alphabet_prefix" = first letter.
Known values: exact, alphabet_prefix
sortModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by type number sort
Sort order for groups.
typestringRequired within parentThe formula result type for grouping.
Must equal: text

Referenced models: Retrieve a view — response body — object view configuration value type table group by type number sort

Retrieve a view — response body — object view / configuration / value / type table / group_by / type formula / group_by / group_by: relative, day, week, month, year, type date

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
group_bystringRequired within parentGranularity for date grouping.
Known values: relative, day, week, month, year
sortModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by type number sort
Sort order for groups.
start_day_of_weekJSONOptional
start_day_of_week (anyOf 1)numberAlternativeStart day of week for week grouping (0 = Sunday, 1 = Monday).
Known values: 0, 1
start_day_of_week (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
typestringRequired within parentThe formula result type for grouping.
Must equal: date

Referenced models: Retrieve a view — response body — object view configuration value type table group by type number sort

Retrieve a view — response body — object view / configuration / value / type table / group_by / type: person, created by, last edited by

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
hide_empty_groupsbooleanOptionalWhether to hide groups that have no items.
property_idstringRequired within parentProperty ID to group by.
property_namestringOptionalProperty name (convenience field).
sortModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by type number sort
Sort order for groups (only manual supported).
typestringRequired within parentThe property type for grouping.
Known values: person, created_by, last_edited_by

Referenced models: Retrieve a view — response body — object view configuration value type table group by type number sort

Retrieve a view — response body — object view / configuration / value / type table / group_by / type: select, multi select

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
hide_empty_groupsbooleanOptionalWhether to hide groups that have no items.
property_idstringRequired within parentProperty ID to group by.
property_namestringOptionalProperty name (convenience field).
sortModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by type number sort
Sort order for groups.
typestringRequired within parentThe property type for grouping.
Known values: select, multi_select

Referenced models: Retrieve a view — response body — object view configuration value type table group by type number sort

Retrieve a view — response body — object view / sorts / array / item / direction: ascending, descending

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
directionstringRequired within parentSort direction.
Known values: ascending, descending
propertystringRequired within parentThe name or ID of the property to sort by.

Retrieve a view — response body — object view / sorts / array / item / direction: ascending, descending, timestamp: created time, last edited time

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
directionstringRequired within parentSort direction.
Known values: ascending, descending
timestampstringRequired within parentThe timestamp to sort by.
Known values: created_time, last_edited_time

Retrieve a view — response body — object view configuration value

FieldTypePresenceDescription and constraints
$JSONRootView configuration, typed by view type (table, board, calendar, etc.).
$ (anyOf 1)ModelAlternativeExpand Retrieve a view — response body — object view configuration value type table
$ (anyOf 2)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / card_layout: list, compact, cover aspect: contain, cover, cover size: small, medium, large, type board
$ (anyOf 3)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / type calendar, view_range: week, month
$ (anyOf 4)ModelAlternativeExpand Retrieve a view — response body — object view configuration value type timeline
$ (anyOf 5)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / card_layout: list, compact, cover aspect: contain, cover, cover size: small, medium, large, type gallery
$ (anyOf 6)ModelAlternativeExpand Retrieve a view — response body — object view configuration value type list
$ (anyOf 7)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / height: small, medium, large, extra large, type map
$ (anyOf 8)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / submission_permissions: none, comment only, reader, read and write, editor, type form
$ (anyOf 9)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / axis_labels: none, x axis, y axis, both, chart type: column, bar, line, donut, number, donut labels: none, value, name, name and value, grid lines: none, horizontal, vertical, both, group style: normal, percent, side by side, height: small, medium, large, extra large, legend position: off, bottom, side, sort: manual, x ascending, x descending, y ascending, y descending, type chart
$ (anyOf 10)ModelAlternativeExpand Retrieve a view — response body — object view configuration value type dashboard

Referenced models: Retrieve a view — response body — object view / configuration / value / card_layout: list, compact, cover aspect: contain, cover, cover size: small, medium, large, type board, Retrieve a view — response body — object view / configuration / value / type calendar, view_range: week, month, Retrieve a view — response body — object view / configuration / value / axis_labels: none, x axis, y axis, both, chart type: column, bar, line, donut, number, donut labels: none, value, name, name and value, grid lines: none, horizontal, vertical, both, group style: normal, percent, side by side, height: small, medium, large, extra large, legend position: off, bottom, side, sort: manual, x ascending, x descending, y ascending, y descending, type chart, Retrieve a view — response body — object view configuration value type dashboard, Retrieve a view — response body — object view / configuration / value / submission_permissions: none, comment only, reader, read and write, editor, type form, Retrieve a view — response body — object view / configuration / value / card_layout: list, compact, cover aspect: contain, cover, cover size: small, medium, large, type gallery, Retrieve a view — response body — object view configuration value type list, Retrieve a view — response body — object view / configuration / value / height: small, medium, large, extra large, type map, Retrieve a view — response body — object view configuration value type table, Retrieve a view — response body — object view configuration value type timeline

Retrieve a view — response body — object view configuration value type dashboard

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
rowsarrayRequired within parentThe rows that make up the dashboard layout. Each row contains one or more widget modules.
Maximum items: 100
rows[]ModelEach itemExpand Retrieve a view — response body — object view configuration value type dashboard rows item
typestringRequired within parentThe view configuration type.
Must equal: dashboard

Referenced models: Retrieve a view — response body — object view configuration value type dashboard rows item

Retrieve a view — response body — object view configuration value type dashboard rows item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
heightJSONOptional
height (anyOf 1)integerAlternativeFixed height of the row in pixels.
height (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentThe ID of this row module.
widgetsarrayRequired within parentThe widget modules within this row.
Maximum items: 100
widgets[]ModelEach itemExpand Retrieve a view — response body — object view configuration value type dashboard rows item widgets item

Referenced models: Retrieve a view — response body — object view configuration value type dashboard rows item widgets item

Retrieve a view — response body — object view configuration value type dashboard rows item widgets item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe ID of this widget module.
row_indexJSONOptional
row_index (anyOf 1)integerAlternativeThe 0-based index of the row this widget belongs to. Widgets in the same row share the same row_index.
row_index (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
view_idstringRequired within parentThe ID of the collection view rendered by this widget.
widthJSONOptional
width (anyOf 1)integerAlternativeWidth of the widget in a 12-column grid (1-12). 12 means full width.
width (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a view — response body — object view configuration value type list

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
propertiesarrayOptionalProperties to display in list items.
Maximum items: 100
properties[]ModelEach itemExpand Retrieve a view — response body — object view configuration value type list properties item
typestringRequired within parentThe view configuration type.
Must equal: list

Referenced models: Retrieve a view — response body — object view configuration value type list properties item

Retrieve a view — response body — object view configuration value type list properties item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
card_property_width_modestringOptionalProperty width mode in compact card layouts (board/gallery).
Known values: full_line, inline
date_formatstringOptionalDate display format (date properties only). "full" = localized full date, "short" = month and day, "month_day_year" = MM/DD/YYYY, "day_month_year" = DD/MM/YYYY, "year_month_day" = YYYY/MM/DD, "relative" = relative dates.
Known values: full, short, month_day_year, day_month_year, year_month_day, relative
property_idstringRequired within parentProperty ID (stable identifier).
property_namestringOptionalProperty name (convenience field, not stable across renames).
status_show_asstringOptionalHow to display status properties (as select dropdown or checkbox).
Known values: select, checkbox
time_formatstringOptionalTime display format (date properties only). "12_hour" = 12-hour clock with AM/PM, "24_hour" = 24-hour clock, "hidden" = hide time.
Known values: 12_hour, 24_hour, hidden
visiblebooleanOptionalWhether this property is visible in the view.
widthJSONOptional
width (anyOf 1)integerAlternativeWidth of the property column in pixels (table view only).
Minimum: 0
width (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
wrapbooleanOptionalWhether to wrap content in this property cell/card.

Retrieve a view — response body — object view configuration value type table

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
frozen_column_indexJSONOptional
frozen_column_index (anyOf 1)integerAlternativeIndex of the last frozen column. Columns up to and including this index are frozen.
Minimum: 0
frozen_column_index (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
group_byModelOptionalExpand Retrieve a view — response body — object view configuration value type table group by
Vertical (row) grouping configuration.
propertiesarrayOptionalColumns/properties visible in the table view.
Maximum items: 100
properties[]ModelEach itemExpand Retrieve a view — response body — object view configuration value type list properties item
show_vertical_linesbooleanOptionalWhether to show vertical lines between columns.
subtasksModelOptionalExpand Retrieve a view — response body — object view configuration value type table subtasks
Sub-item (subtask) display configuration.
typestringRequired within parentThe view configuration type.
Must equal: table
wrap_cellsbooleanOptionalWhether to wrap cell content by default.

Referenced models: Retrieve a view — response body — object view configuration value type table group by, Retrieve a view — response body — object view configuration value type table subtasks, Retrieve a view — response body — object view configuration value type list properties item

Retrieve a view — response body — object view configuration value type table group by

FieldTypePresenceDescription and constraints
$JSONRootGroup-by configuration based on property type.
$ (anyOf 1)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / type table / group_by / type: select, multi select
$ (anyOf 2)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / type table / group_by / group_by: group, option, type status
$ (anyOf 3)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / type table / group_by / type: person, created by, last edited by
$ (anyOf 4)ModelAlternativeExpand Retrieve a view — response body — object view configuration value type table group by type relation
$ (anyOf 5)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / type table / group_by / group_by: relative, day, week, month, year, type: date, created time, last edited time
$ (anyOf 6)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / type table / group_by / group_by: exact, alphabet prefix, type: text, title, url, email, phone number
$ (anyOf 7)ModelAlternativeExpand Retrieve a view — response body — object view configuration value type table group by type number
$ (anyOf 8)ModelAlternativeExpand Retrieve a view — response body — object view configuration value type table group by type checkbox
$ (anyOf 9)ModelAlternativeExpand Retrieve a view — response body — object view configuration value type table group by type formula

Referenced models: Retrieve a view — response body — object view configuration value type table group by type checkbox, Retrieve a view — response body — object view / configuration / value / type table / group_by / group_by: relative, day, week, month, year, type: date, created time, last edited time, Retrieve a view — response body — object view configuration value type table group by type formula, Retrieve a view — response body — object view configuration value type table group by type number, Retrieve a view — response body — object view / configuration / value / type table / group_by / type: person, created by, last edited by, Retrieve a view — response body — object view configuration value type table group by type relation, Retrieve a view — response body — object view / configuration / value / type table / group_by / type: select, multi select, Retrieve a view — response body — object view / configuration / value / type table / group_by / group_by: group, option, type status, Retrieve a view — response body — object view / configuration / value / type table / group_by / group_by: exact, alphabet prefix, type: text, title, url, email, phone number

Retrieve a view — response body — object view configuration value type table group by type checkbox

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
hide_empty_groupsbooleanOptionalWhether to hide groups that have no items.
property_idstringRequired within parentProperty ID to group by.
property_namestringOptionalProperty name (convenience field).
sortModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by type number sort
Sort order for groups (only manual for checkbox).
typestringRequired within parentThe property type for grouping.
Must equal: checkbox

Referenced models: Retrieve a view — response body — object view configuration value type table group by type number sort

Retrieve a view — response body — object view configuration value type table group by type formula

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
group_byModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by type formula group by
Sub-group-by configuration based on the formula result type.
hide_empty_groupsbooleanOptionalWhether to hide groups that have no items.
property_idstringRequired within parentProperty ID of the formula to group by.
property_namestringOptionalProperty name (convenience field).
typestringRequired within parentThe property type for grouping.
Must equal: formula

Referenced models: Retrieve a view — response body — object view configuration value type table group by type formula group by

Retrieve a view — response body — object view configuration value type table group by type formula group by

FieldTypePresenceDescription and constraints
$JSONRootSub-group-by configuration for formula properties based on result type.
$ (anyOf 1)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / type table / group_by / type formula / group_by / group_by: relative, day, week, month, year, type date
$ (anyOf 2)ModelAlternativeExpand Retrieve a view — response body — object view / configuration / value / type table / group_by / type formula / group_by / group_by: exact, alphabet prefix, type text
$ (anyOf 3)ModelAlternativeExpand Retrieve a view — response body — object view configuration value type table group by type formula group by type number
$ (anyOf 4)ModelAlternativeExpand Retrieve a view — response body — object view configuration value type table group by type formula group by type checkbox

Referenced models: Retrieve a view — response body — object view configuration value type table group by type formula group by type checkbox, Retrieve a view — response body — object view / configuration / value / type table / group_by / type formula / group_by / group_by: relative, day, week, month, year, type date, Retrieve a view — response body — object view configuration value type table group by type formula group by type number, Retrieve a view — response body — object view / configuration / value / type table / group_by / type formula / group_by / group_by: exact, alphabet prefix, type text

Retrieve a view — response body — object view configuration value type table group by type formula group by type checkbox

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
sortModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by type number sort
Sort order for groups (only manual for checkbox).
typestringRequired within parentThe formula result type for grouping.
Must equal: checkbox

Referenced models: Retrieve a view — response body — object view configuration value type table group by type number sort

Retrieve a view — response body — object view configuration value type table group by type formula group by type number

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
range_endJSONOptional
range_end (anyOf 1)integerAlternativeEnd of the range for number grouping buckets.
range_end (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
range_sizeJSONOptional
range_size (anyOf 1)integerAlternativeSize of each bucket in number grouping.
Minimum: 1
range_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
range_startJSONOptional
range_start (anyOf 1)integerAlternativeStart of the range for number grouping buckets.
range_start (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sortModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by type number sort
Sort order for groups (ascending or descending only).
typestringRequired within parentThe formula result type for grouping.
Must equal: number

Referenced models: Retrieve a view — response body — object view configuration value type table group by type number sort

Retrieve a view — response body — object view configuration value type table group by type number

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
hide_empty_groupsbooleanOptionalWhether to hide groups that have no items.
property_idstringRequired within parentProperty ID to group by.
property_namestringOptionalProperty name (convenience field).
range_endJSONOptional
range_end (anyOf 1)integerAlternativeEnd of the range for number grouping buckets.
range_end (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
range_sizeJSONOptional
range_size (anyOf 1)integerAlternativeSize of each bucket in number grouping.
Minimum: 1
range_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
range_startJSONOptional
range_start (anyOf 1)integerAlternativeStart of the range for number grouping buckets.
range_start (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sortModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by type number sort
Sort order for groups (ascending or descending only).
typestringRequired within parentThe property type for grouping.
Must equal: number

Referenced models: Retrieve a view — response body — object view configuration value type table group by type number sort

Retrieve a view — response body — object view configuration value type table group by type number sort

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
typestringRequired within parentSort direction for groups.
Known values: manual, ascending, descending

Retrieve a view — response body — object view configuration value type table group by type relation

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
hide_empty_groupsbooleanOptionalWhether to hide groups that have no items.
property_idstringRequired within parentProperty ID to group by.
property_namestringOptionalProperty name (convenience field).
sortModelRequired within parentExpand Retrieve a view — response body — object view configuration value type table group by type number sort
Sort order for groups.
typestringRequired within parentThe property type for grouping.
Must equal: relation

Referenced models: Retrieve a view — response body — object view configuration value type table group by type number sort

Retrieve a view — response body — object view configuration value type table subtasks

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
display_modestringOptionalHow sub-items are displayed. "show" renders hierarchically with toggles, "hidden" shows parents with a count, "flattened" shows sub-items with a parent indicator, "disabled" turns off sub-item rendering.
Known values: show, hidden, flattened, disabled
filter_scopestringOptionalWhich items are included when filtering. "parents" includes parent items only, "parents_and_subitems" includes both, "subitems" includes sub-items only.
Known values: parents, parents_and_subitems, subitems
property_idstringOptionalRelation property ID used for parent-child nesting.
toggle_column_idstringOptionalProperty ID of the column showing the sub-item expand/collapse toggle.

Retrieve a view — response body — object view configuration value type timeline

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
arrows_byModelOptionalExpand Retrieve a view — response body — object view configuration value type timeline arrows by
Dependency arrows configuration.
color_bybooleanOptionalWhether to color-code items by property.
date_property_idstringRequired within parentStart date property - required.
date_property_namestringOptionalStart date property name (convenience field).
end_date_property_idstringOptionalEnd date property (optional, for items that span a range).
end_date_property_namestringOptionalEnd date property name (convenience field).
preferenceModelOptionalExpand Retrieve a view — response body — object view configuration value type timeline preference
Timeline zoom/preference state.
propertiesarrayOptionalProperties to display on timeline items.
Maximum items: 100
properties[]ModelEach itemExpand Retrieve a view — response body — object view configuration value type list properties item
show_tablebooleanOptionalWhether to show the table panel alongside the timeline.
table_propertiesarrayOptionalProperties to display in the table panel (when show_table is true).
Maximum items: 100
table_properties[]ModelEach itemExpand Retrieve a view — response body — object view configuration value type list properties item
typestringRequired within parentThe view configuration type.
Must equal: timeline

Referenced models: Retrieve a view — response body — object view configuration value type timeline arrows by, Retrieve a view — response body — object view configuration value type timeline preference, Retrieve a view — response body — object view configuration value type list properties item

Retrieve a view — response body — object view configuration value type timeline arrows by

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
property_idJSONOptionalRelation property ID used for dependency arrows.
property_id (anyOf 1)stringAlternative
property_id (anyOf 2)nullAlternative

Retrieve a view — response body — object view configuration value type timeline preference

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
center_timestampJSONOptional
center_timestamp (anyOf 1)integerAlternativeCenter timestamp for the timeline view (Unix timestamp in ms).
Minimum: 0
center_timestamp (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
zoom_levelstringRequired within parentZoom level for the timeline.
Known values: hours, day, week, bi_week, month, quarter, year, 5_years

Retrieve a view — response body — object view filter value

FieldTypePresenceDescription and constraints
$JSONRootFilter for the view. Can be a property filter (filter by property value), timestamp filter (filter by created_time or last_edited_time), or compound filter (combine filters with and/or logic). Compound filters support up to 2 levels of nesting.
$ (anyOf 1)objectAlternativeA filter condition on a specific property. The property field specifies which property to filter, and an additional field specifies the filter type and condition (e.g., title, rich_text, number, checkbox, select, multi_select, date, people, files, relation, formula, rollup, etc.).
Additional keys: allowed
$ (anyOf 1).propertystringRequired within parentThe name or ID of the property to filter on.
$ (anyOf 2)objectAlternativeA filter condition on a timestamp (created_time or last_edited_time). The timestamp field specifies which timestamp, and a matching field contains the date filter condition.
Additional keys: allowed
$ (anyOf 2).timestampstringRequired within parentThe timestamp to filter on.
Known values: created_time, last_edited_time
$ (anyOf 3)objectAlternativeA compound filter that combines multiple filters with AND or OR logic. Supports up to 2 levels of nesting.
$ (anyOf 3).andarrayOptionalFilters combined with AND logic.
$ (anyOf 3).and[]JSONEach itemA filter that can be a property filter, timestamp filter, or nested compound filter.
$ (anyOf 3).and[] (anyOf 1)objectAlternativeA filter condition on a specific property. The property field specifies which property to filter, and an additional field specifies the filter type and condition (e.g., title, rich_text, number, checkbox, select, multi_select, date, people, files, relation, formula, rollup, etc.).
Additional keys: allowed
$ (anyOf 3).and[] (anyOf 1).propertystringRequired within parentThe name or ID of the property to filter on.
$ (anyOf 3).and[] (anyOf 2)objectAlternativeA filter condition on a timestamp (created_time or last_edited_time). The timestamp field specifies which timestamp, and a matching field contains the date filter condition.
Additional keys: allowed
$ (anyOf 3).and[] (anyOf 2).timestampstringRequired within parentThe timestamp to filter on.
Known values: created_time, last_edited_time
$ (anyOf 3).and[] (anyOf 3)ModelAlternativeExpand Retrieve a view — response body — object view filter value and, or or item and, or
$ (anyOf 3).orarrayOptionalFilters combined with OR logic.
$ (anyOf 3).or[]JSONEach itemA filter that can be a property filter, timestamp filter, or nested compound filter.
$ (anyOf 3).or[] (anyOf 1)objectAlternativeA filter condition on a specific property. The property field specifies which property to filter, and an additional field specifies the filter type and condition (e.g., title, rich_text, number, checkbox, select, multi_select, date, people, files, relation, formula, rollup, etc.).
Additional keys: allowed
$ (anyOf 3).or[] (anyOf 1).propertystringRequired within parentThe name or ID of the property to filter on.
$ (anyOf 3).or[] (anyOf 2)objectAlternativeA filter condition on a timestamp (created_time or last_edited_time). The timestamp field specifies which timestamp, and a matching field contains the date filter condition.
Additional keys: allowed
$ (anyOf 3).or[] (anyOf 2).timestampstringRequired within parentThe timestamp to filter on.
Known values: created_time, last_edited_time
$ (anyOf 3).or[] (anyOf 3)ModelAlternativeExpand Retrieve a view — response body — object view filter value and, or or item and, or

Referenced models: Retrieve a view — response body — object view filter value and, or or item and, or

Retrieve a view — response body — object view filter value and, or or item and, or

FieldTypePresenceDescription and constraints
$objectRootA compound filter at the deepest nesting level. Can only contain property or timestamp filters (no further nesting).
andarrayOptionalFilters combined with AND logic.
and[]JSONEach itemA property filter or timestamp filter.
and[] (anyOf 1)objectAlternativeA filter condition on a specific property. The property field specifies which property to filter, and an additional field specifies the filter type and condition (e.g., title, rich_text, number, checkbox, select, multi_select, date, people, files, relation, formula, rollup, etc.).
Additional keys: allowed
and[] (anyOf 1).propertystringRequired within parentThe name or ID of the property to filter on.
and[] (anyOf 2)objectAlternativeA filter condition on a timestamp (created_time or last_edited_time). The timestamp field specifies which timestamp, and a matching field contains the date filter condition.
Additional keys: allowed
and[] (anyOf 2).timestampstringRequired within parentThe timestamp to filter on.
Known values: created_time, last_edited_time
orarrayOptionalFilters combined with OR logic.
or[]JSONEach itemA property filter or timestamp filter.
or[] (anyOf 1)objectAlternativeA filter condition on a specific property. The property field specifies which property to filter, and an additional field specifies the filter type and condition (e.g., title, rich_text, number, checkbox, select, multi_select, date, people, files, relation, formula, rollup, etc.).
Additional keys: allowed
or[] (anyOf 1).propertystringRequired within parentThe name or ID of the property to filter on.
or[] (anyOf 2)objectAlternativeA filter condition on a timestamp (created_time or last_edited_time). The timestamp field specifies which timestamp, and a matching field contains the date filter condition.
Additional keys: allowed
or[] (anyOf 2).timestampstringRequired within parentThe timestamp to filter on.
Known values: created_time, last_edited_time

Retrieve a view — response body — object view quick filters object value

FieldTypePresenceDescription and constraints
$objectRootA property filter condition. Same shape as a property filter but without the "property" field. For example: { "select": { "equals": "High" } }. An empty object means the quick filter has no criteria yet.

Retrieve a view — response body — object view sorts array item

FieldTypePresenceDescription and constraints
$JSONRootSort for the view. Can sort by property or timestamp.
$ (anyOf 1)ModelAlternativeExpand Retrieve a view — response body — object view / sorts / array / item / direction: ascending, descending
$ (anyOf 2)ModelAlternativeExpand Retrieve a view — response body — object view / sorts / array / item / direction: ascending, descending, timestamp: created time, last edited time

Referenced models: Retrieve a view — response body — object view / sorts / array / item / direction: ascending, descending, Retrieve a view — response body — object view / sorts / array / item / direction: ascending, descending, timestamp: created time, last edited time

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.