Notion: Views schemas
52 Notion schemas with complete fields and constraints.
← Views operations · All schemas
Create a view query — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
page_size | integer | Optional | The number of results to return per page. Maximum: 100 Maximum: 100 Minimum: 1 |
Create a view query — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
expires_at | string | Required within parent | When the cached query results expire. Format: date-time |
has_more | boolean | Required within parent | Whether there are more results. |
id | string | Required within parent | The query ID. Format: uuid |
next_cursor | JSON | Required within parent | Cursor for the next page of results. |
next_cursor (anyOf 1) | string | Alternative | Format: uuid |
next_cursor (anyOf 2) | null | Alternative | |
object | string | Required within parent | The object type. Must equal: view_query |
request_status | Model | Optional | Expand 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. |
results | array | Required within parent | The page results for this page. Maximum items: 100 |
results[] | Model | Each item | Expand Create a view query — response body — results item |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | number | Alternative | Total number of results in the query. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
view_id | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | The object ID. Format: uuid |
object | string | Required within parent | The object type. |
Delete a view query — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
deleted | boolean | Required within parent | Whether the view query was deleted. |
id | string | Required within parent | The ID of the deleted view query. Format: uuid |
object | string | Required within parent | The object type. Must equal: view_query |
Delete a view — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | The ID of the view. Format: uuid |
object | string | Required within parent | The object type name. Must equal: view |
parent | Model | Required within parent | Expand Delete a view — response body — parent The parent database of the view. |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
database_id | string | Required within parent | The ID of the parent database. Format: uuid |
type | string | Required within parent | The parent type. Must equal: database_id |
List views — response body — request status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
incomplete_reason | string | Optional | Why the result set is incomplete. Only present when `type` is `incomplete`. Must equal: query_result_limit_reached |
type | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | The ID of the view. Format: uuid |
object | string | Required within parent | The object type name. Must equal: view |
List views — response body — view
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
Retrieve a view — response body — object view
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
configuration | JSON | Optional | View presentation configuration. |
configuration (anyOf 1) | Model | Alternative | Expand Retrieve a view — response body — object view configuration value |
configuration (anyOf 2) | null | Alternative | |
created_by | JSON | Optional | The user who created the view, or null if not available. |
created_by (anyOf 1) | Model | Alternative | Expand Update page — response body — object page created by |
created_by (anyOf 2) | null | Alternative | |
created_time | string | Required within parent | The time when the view was created. Format: date-time |
dashboard_view_id | string | Optional | For dashboard widget views, the ID of the parent dashboard view. Only present when this view is a widget inside a dashboard. |
data_source_id | JSON | Optional | The ID of the data source this view is scoped to, or null for dashboard views. |
data_source_id (anyOf 1) | string | Alternative | |
data_source_id (anyOf 2) | null | Alternative | |
filter | JSON | Optional | The filter applied to this view (same shape as data source query filter). |
filter (anyOf 1) | Model | Alternative | Expand Retrieve a view — response body — object view filter value |
filter (anyOf 2) | null | Alternative | |
id | string | Required within parent | The ID of the view. Format: uuid |
last_edited_by | JSON | Optional | The user who last edited the view, or null if not available. |
last_edited_by (anyOf 1) | Model | Alternative | Expand Update page — response body — object page created by |
last_edited_by (anyOf 2) | null | Alternative | |
last_edited_time | string | Required within parent | The time when the view was last edited. Format: date-time |
name | string | Required within parent | The name of the view. |
object | string | Required within parent | The object type name. Must equal: view |
parent | Model | Required within parent | Expand Delete a view — response body — parent The parent database of the view. |
quick_filters | JSON | Optional | Quick 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) | object | Alternative | Additional keys: see wildcard field |
quick_filters (anyOf 1).* | Model | Additional keys | Expand Retrieve a view — response body — object view quick filters object value |
quick_filters (anyOf 2) | null | Alternative | |
sorts | JSON | Optional | The sorts applied to this view (same shape as data source query sorts). |
sorts (anyOf 1) | array | Alternative | Maximum items: 100 |
sorts (anyOf 1)[] | Model | Each item | Expand Retrieve a view — response body — object view sorts array item |
sorts (anyOf 2) | null | Alternative | |
type | string | Required within parent | The view type. Known values: table, board, list, calendar, timeline, gallery, form, chart, map, dashboard |
url | string | Required within parent | Canonical 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
axis_labels | string | Optional | Which axis labels to display. Known values: none, x_axis, y_axis, both |
caption | JSON | Optional | Text caption displayed below the chart. Null when no caption is shown. |
caption (anyOf 1) | string | Alternative | |
caption (anyOf 2) | null | Alternative | |
chart_type | string | Required within parent | The chart type: column (vertical bars), bar (horizontal bars), line, donut, or number (single value display). Known values: column, bar, line, donut, number |
color_by_value | boolean | Optional | Whether chart elements are colored by their numeric value (gradient coloring). |
color_theme | string | Optional | Color theme for the chart. Known values: gray, blue, yellow, green, purple, teal, orange, pink, red, auto, colorful |
cumulative | boolean | Optional | Whether to show cumulative values (line charts only). |
donut_labels | string | Optional | What to display on donut chart slices. Known values: none, value, name, name_and_value |
grid_lines | string | Optional | Which grid lines to display. Known values: none, horizontal, vertical, both |
group_style | string | Optional | How 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 |
height | string | Optional | Chart height. Known values: small, medium, large, extra_large |
hide_empty_groups | boolean | Optional | Whether to hide groups with no data on the x-axis. |
hide_line_fill_area | boolean | Optional | Whether to hide the shaded area under the line (line charts only). |
hide_title | boolean | Optional | Whether to hide the title label (number charts only). |
legend_position | string | Optional | Legend display position. "off" hides the legend. Known values: off, bottom, side |
reference_lines | JSON | Optional | Reference lines drawn on the chart. Null when no reference lines are configured. |
reference_lines (anyOf 1) | array | Alternative | Maximum items: 100 |
reference_lines (anyOf 1)[] | Model | Each item | Expand 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) | null | Alternative | |
show_data_labels | boolean | Optional | Whether to show data value labels on chart elements. |
smooth_line | boolean | Optional | Whether to use smooth curves (line charts only). |
sort | string | Optional | Sort order for chart data. Known values: manual, x_ascending, x_descending, y_ascending, y_descending |
stack_by | JSON | Optional | Stack-by grouping configuration for stacked/grouped bar charts (column/bar/line only). Null when not stacked. |
stack_by (anyOf 1) | Model | Alternative | Expand Retrieve a view — response body — object view configuration value type table group by |
stack_by (anyOf 2) | null | Alternative | |
type | string | Required within parent | The view configuration type. Must equal: chart |
value | Model | Optional | Expand 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_axis | JSON | Optional | X-axis grouping configuration for column/bar/line/donut charts using grouped data. Null when using results (raw property values) mode. |
x_axis (anyOf 1) | Model | Alternative | Expand Retrieve a view — response body — object view configuration value type table group by |
x_axis (anyOf 2) | null | Alternative | |
x_axis_property_id | string | Optional | Property ID for the x-axis name values when using results (raw property values) mode. |
y_axis | JSON | Optional | Y-axis aggregation for column/bar/line/donut charts using grouped data. Null when using results mode. |
y_axis (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
y_axis_max | JSON | Optional | Custom maximum value for the y-axis. Null clears the override. |
y_axis_max (anyOf 1) | JSON | Alternative | |
y_axis_max (anyOf 1) (anyOf 1) | number | Alternative | |
y_axis_max (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
y_axis_max (anyOf 2) | null | Alternative | |
y_axis_min | JSON | Optional | Custom minimum value for the y-axis. Null clears the override. |
y_axis_min (anyOf 1) | JSON | Alternative | |
y_axis_min (anyOf 1) (anyOf 1) | number | Alternative | |
y_axis_min (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
y_axis_min (anyOf 2) | null | Alternative | |
y_axis_property_id | string | Optional | Property 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
color | string | Required within parent | Color of the reference line. Known values: gray, lightgray, brown, yellow, orange, green, blue, purple, pink, red |
dash_style | string | Required within parent | Line style: "solid" for a continuous line, "dash" for a dashed line. Known values: solid, dash |
id | string | Required within parent | Unique identifier for the reference line. |
label | string | Required within parent | Label displayed alongside the reference line. |
value | JSON | Required within parent | |
value (anyOf 1) | number | Alternative | The y-axis value where the reference line is drawn. |
value (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
aggregator | string | Required within parent | The 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_id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
card_layout | string | Optional | Card layout mode (list shows all properties, compact shows inline). Known values: list, compact |
cover | Model | Optional | Expand 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_aspect | string | Optional | Cover image aspect ratio. Known values: contain, cover |
cover_size | string | Optional | Cover image size. Known values: small, medium, large |
group_by | Model | Required within parent | Expand Retrieve a view — response body — object view configuration value type table group by Column (horizontal) grouping - required for board view. |
properties | array | Optional | Properties to display on each card. Maximum items: 100 |
properties[] | Model | Each item | Expand Retrieve a view — response body — object view configuration value type list properties item |
sub_group_by | Model | Optional | Expand Retrieve a view — response body — object view configuration value type table group by Sub-grouping (vertical swimlanes within columns). |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
property_id | string | Optional | Property ID when type is "property". |
type | string | Required within parent | Source 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
card_layout | string | Optional | Card layout mode (list shows all properties, compact shows inline). Known values: list, compact |
cover | Model | Optional | Expand 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_aspect | string | Optional | Cover image aspect ratio. Known values: contain, cover |
cover_size | string | Optional | Cover image size. Known values: small, medium, large |
properties | array | Optional | Properties to display on gallery cards. Maximum items: 100 |
properties[] | Model | Each item | Expand Retrieve a view — response body — object view configuration value type list properties item |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
height | string | Optional | Map display height. Known values: small, medium, large, extra_large |
map_by | string | Optional | Property ID of the location property used to position items on the map. |
map_by_property_name | string | Optional | Map-by property name (convenience field). |
properties | array | Optional | Properties to display on map pin cards. Maximum items: 100 |
properties[] | Model | Each item | Expand Retrieve a view — response body — object view configuration value type list properties item |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
anonymous_submissions | boolean | Optional | Whether anonymous (non-logged-in) submissions are allowed. |
is_form_closed | boolean | Optional | Whether the form is closed for submissions. |
submission_permissions | string | Optional | Permission level granted to the submitter on the created page after form submission. Known values: none, comment_only, reader, read_and_write, editor |
type | string | Required within parent | The view configuration type. Must equal: form |
Retrieve a view — response body — object view / configuration / value / type calendar, view_range: week, month
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
date_property_id | string | Required within parent | Date property used to position items on the calendar - required. |
date_property_name | string | Optional | Date property name (convenience field). |
properties | array | Optional | Properties to display on calendar event cards. Maximum items: 100 |
properties[] | Model | Each item | Expand Retrieve a view — response body — object view configuration value type list properties item |
show_weekends | boolean | Optional | Whether to show weekend days. |
type | string | Required within parent | The view configuration type. Must equal: calendar |
view_range | string | Optional | Calendar 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
group_by | string | Required within parent | How to group text values. "exact" = exact match, "alphabet_prefix" = first letter. Known values: exact, alphabet_prefix |
hide_empty_groups | boolean | Optional | Whether to hide groups that have no items. |
property_id | string | Required within parent | Property ID to group by. |
property_name | string | Optional | Property name (convenience field). |
sort | Model | Required within parent | Expand Retrieve a view — response body — object view configuration value type table group by type number sort Sort order for groups. |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
group_by | string | Required within parent | How 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_groups | boolean | Optional | Whether to hide groups that have no items. |
property_id | string | Required within parent | Property ID to group by. |
property_name | string | Optional | Property name (convenience field). |
sort | Model | Required within parent | Expand Retrieve a view — response body — object view configuration value type table group by type number sort Sort order for groups. |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
group_by | string | Required within parent | Granularity for date grouping. Known values: relative, day, week, month, year |
hide_empty_groups | boolean | Optional | Whether to hide groups that have no items. |
property_id | string | Required within parent | Property ID to group by. |
property_name | string | Optional | Property name (convenience field). |
sort | Model | Required within parent | Expand 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_week | JSON | Optional | |
start_day_of_week (anyOf 1) | number | Alternative | Start day of week for week grouping (0 = Sunday, 1 = Monday). Known values: 0, 1 |
start_day_of_week (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
group_by | string | Required within parent | How to group text values. "exact" = exact match, "alphabet_prefix" = first letter. Known values: exact, alphabet_prefix |
sort | Model | Required within parent | Expand Retrieve a view — response body — object view configuration value type table group by type number sort Sort order for groups. |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
group_by | string | Required within parent | Granularity for date grouping. Known values: relative, day, week, month, year |
sort | Model | Required within parent | Expand Retrieve a view — response body — object view configuration value type table group by type number sort Sort order for groups. |
start_day_of_week | JSON | Optional | |
start_day_of_week (anyOf 1) | number | Alternative | Start day of week for week grouping (0 = Sunday, 1 = Monday). Known values: 0, 1 |
start_day_of_week (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
hide_empty_groups | boolean | Optional | Whether to hide groups that have no items. |
property_id | string | Required within parent | Property ID to group by. |
property_name | string | Optional | Property name (convenience field). |
sort | Model | Required within parent | Expand Retrieve a view — response body — object view configuration value type table group by type number sort Sort order for groups (only manual supported). |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
hide_empty_groups | boolean | Optional | Whether to hide groups that have no items. |
property_id | string | Required within parent | Property ID to group by. |
property_name | string | Optional | Property name (convenience field). |
sort | Model | Required within parent | Expand Retrieve a view — response body — object view configuration value type table group by type number sort Sort order for groups. |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
direction | string | Required within parent | Sort direction. Known values: ascending, descending |
property | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
direction | string | Required within parent | Sort direction. Known values: ascending, descending |
timestamp | string | Required within parent | The timestamp to sort by. Known values: created_time, last_edited_time |
Retrieve a view — response body — object view configuration value
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
rows | array | Required within parent | The rows that make up the dashboard layout. Each row contains one or more widget modules. Maximum items: 100 |
rows[] | Model | Each item | Expand Retrieve a view — response body — object view configuration value type dashboard rows item |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
height | JSON | Optional | |
height (anyOf 1) | integer | Alternative | Fixed height of the row in pixels. |
height (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | The ID of this row module. |
widgets | array | Required within parent | The widget modules within this row. Maximum items: 100 |
widgets[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | The ID of this widget module. |
row_index | JSON | Optional | |
row_index (anyOf 1) | integer | Alternative | The 0-based index of the row this widget belongs to. Widgets in the same row share the same row_index. |
row_index (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
view_id | string | Required within parent | The ID of the collection view rendered by this widget. |
width | JSON | Optional | |
width (anyOf 1) | integer | Alternative | Width of the widget in a 12-column grid (1-12). 12 means full width. |
width (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a view — response body — object view configuration value type list
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
properties | array | Optional | Properties to display in list items. Maximum items: 100 |
properties[] | Model | Each item | Expand Retrieve a view — response body — object view configuration value type list properties item |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
card_property_width_mode | string | Optional | Property width mode in compact card layouts (board/gallery). Known values: full_line, inline |
date_format | string | Optional | Date 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_id | string | Required within parent | Property ID (stable identifier). |
property_name | string | Optional | Property name (convenience field, not stable across renames). |
status_show_as | string | Optional | How to display status properties (as select dropdown or checkbox). Known values: select, checkbox |
time_format | string | Optional | Time 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 |
visible | boolean | Optional | Whether this property is visible in the view. |
width | JSON | Optional | |
width (anyOf 1) | integer | Alternative | Width of the property column in pixels (table view only). Minimum: 0 |
width (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
wrap | boolean | Optional | Whether to wrap content in this property cell/card. |
Retrieve a view — response body — object view configuration value type table
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
frozen_column_index | JSON | Optional | |
frozen_column_index (anyOf 1) | integer | Alternative | Index of the last frozen column. Columns up to and including this index are frozen. Minimum: 0 |
frozen_column_index (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
group_by | Model | Optional | Expand Retrieve a view — response body — object view configuration value type table group by Vertical (row) grouping configuration. |
properties | array | Optional | Columns/properties visible in the table view. Maximum items: 100 |
properties[] | Model | Each item | Expand Retrieve a view — response body — object view configuration value type list properties item |
show_vertical_lines | boolean | Optional | Whether to show vertical lines between columns. |
subtasks | Model | Optional | Expand Retrieve a view — response body — object view configuration value type table subtasks Sub-item (subtask) display configuration. |
type | string | Required within parent | The view configuration type. Must equal: table |
wrap_cells | boolean | Optional | Whether 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
hide_empty_groups | boolean | Optional | Whether to hide groups that have no items. |
property_id | string | Required within parent | Property ID to group by. |
property_name | string | Optional | Property name (convenience field). |
sort | Model | Required within parent | Expand Retrieve a view — response body — object view configuration value type table group by type number sort Sort order for groups (only manual for checkbox). |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
group_by | Model | Required within parent | Expand 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_groups | boolean | Optional | Whether to hide groups that have no items. |
property_id | string | Required within parent | Property ID of the formula to group by. |
property_name | string | Optional | Property name (convenience field). |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Sub-group-by configuration for formula properties based on result type. |
$ (anyOf 1) | Model | Alternative | Expand 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) | Model | Alternative | Expand 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) | Model | Alternative | Expand Retrieve a view — response body — object view configuration value type table group by type formula group by type number |
$ (anyOf 4) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
sort | Model | Required within parent | Expand Retrieve a view — response body — object view configuration value type table group by type number sort Sort order for groups (only manual for checkbox). |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
range_end | JSON | Optional | |
range_end (anyOf 1) | integer | Alternative | End of the range for number grouping buckets. |
range_end (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
range_size | JSON | Optional | |
range_size (anyOf 1) | integer | Alternative | Size of each bucket in number grouping. Minimum: 1 |
range_size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
range_start | JSON | Optional | |
range_start (anyOf 1) | integer | Alternative | Start of the range for number grouping buckets. |
range_start (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sort | Model | Required within parent | Expand Retrieve a view — response body — object view configuration value type table group by type number sort Sort order for groups (ascending or descending only). |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
hide_empty_groups | boolean | Optional | Whether to hide groups that have no items. |
property_id | string | Required within parent | Property ID to group by. |
property_name | string | Optional | Property name (convenience field). |
range_end | JSON | Optional | |
range_end (anyOf 1) | integer | Alternative | End of the range for number grouping buckets. |
range_end (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
range_size | JSON | Optional | |
range_size (anyOf 1) | integer | Alternative | Size of each bucket in number grouping. Minimum: 1 |
range_size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
range_start | JSON | Optional | |
range_start (anyOf 1) | integer | Alternative | Start of the range for number grouping buckets. |
range_start (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
sort | Model | Required within parent | Expand Retrieve a view — response body — object view configuration value type table group by type number sort Sort order for groups (ascending or descending only). |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
type | string | Required within parent | Sort direction for groups. Known values: manual, ascending, descending |
Retrieve a view — response body — object view configuration value type table group by type relation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
hide_empty_groups | boolean | Optional | Whether to hide groups that have no items. |
property_id | string | Required within parent | Property ID to group by. |
property_name | string | Optional | Property name (convenience field). |
sort | Model | Required within parent | Expand Retrieve a view — response body — object view configuration value type table group by type number sort Sort order for groups. |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
display_mode | string | Optional | How 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_scope | string | Optional | Which 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_id | string | Optional | Relation property ID used for parent-child nesting. |
toggle_column_id | string | Optional | Property ID of the column showing the sub-item expand/collapse toggle. |
Retrieve a view — response body — object view configuration value type timeline
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
arrows_by | Model | Optional | Expand Retrieve a view — response body — object view configuration value type timeline arrows by Dependency arrows configuration. |
color_by | boolean | Optional | Whether to color-code items by property. |
date_property_id | string | Required within parent | Start date property - required. |
date_property_name | string | Optional | Start date property name (convenience field). |
end_date_property_id | string | Optional | End date property (optional, for items that span a range). |
end_date_property_name | string | Optional | End date property name (convenience field). |
preference | Model | Optional | Expand Retrieve a view — response body — object view configuration value type timeline preference Timeline zoom/preference state. |
properties | array | Optional | Properties to display on timeline items. Maximum items: 100 |
properties[] | Model | Each item | Expand Retrieve a view — response body — object view configuration value type list properties item |
show_table | boolean | Optional | Whether to show the table panel alongside the timeline. |
table_properties | array | Optional | Properties to display in the table panel (when show_table is true). Maximum items: 100 |
table_properties[] | Model | Each item | Expand Retrieve a view — response body — object view configuration value type list properties item |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
property_id | JSON | Optional | Relation property ID used for dependency arrows. |
property_id (anyOf 1) | string | Alternative | |
property_id (anyOf 2) | null | Alternative |
Retrieve a view — response body — object view configuration value type timeline preference
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
center_timestamp | JSON | Optional | |
center_timestamp (anyOf 1) | integer | Alternative | Center timestamp for the timeline view (Unix timestamp in ms). Minimum: 0 |
center_timestamp (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
zoom_level | string | Required within parent | Zoom 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Filter 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) | object | Alternative | A 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).property | string | Required within parent | The name or ID of the property to filter on. |
$ (anyOf 2) | object | Alternative | A 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).timestamp | string | Required within parent | The timestamp to filter on. Known values: created_time, last_edited_time |
$ (anyOf 3) | object | Alternative | A compound filter that combines multiple filters with AND or OR logic. Supports up to 2 levels of nesting. |
$ (anyOf 3).and | array | Optional | Filters combined with AND logic. |
$ (anyOf 3).and[] | JSON | Each item | A filter that can be a property filter, timestamp filter, or nested compound filter. |
$ (anyOf 3).and[] (anyOf 1) | object | Alternative | A 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).property | string | Required within parent | The name or ID of the property to filter on. |
$ (anyOf 3).and[] (anyOf 2) | object | Alternative | A 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).timestamp | string | Required within parent | The timestamp to filter on. Known values: created_time, last_edited_time |
$ (anyOf 3).and[] (anyOf 3) | Model | Alternative | Expand Retrieve a view — response body — object view filter value and, or or item and, or |
$ (anyOf 3).or | array | Optional | Filters combined with OR logic. |
$ (anyOf 3).or[] | JSON | Each item | A filter that can be a property filter, timestamp filter, or nested compound filter. |
$ (anyOf 3).or[] (anyOf 1) | object | Alternative | A 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).property | string | Required within parent | The name or ID of the property to filter on. |
$ (anyOf 3).or[] (anyOf 2) | object | Alternative | A 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).timestamp | string | Required within parent | The timestamp to filter on. Known values: created_time, last_edited_time |
$ (anyOf 3).or[] (anyOf 3) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A compound filter at the deepest nesting level. Can only contain property or timestamp filters (no further nesting). |
and | array | Optional | Filters combined with AND logic. |
and[] | JSON | Each item | A property filter or timestamp filter. |
and[] (anyOf 1) | object | Alternative | A 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).property | string | Required within parent | The name or ID of the property to filter on. |
and[] (anyOf 2) | object | Alternative | A 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).timestamp | string | Required within parent | The timestamp to filter on. Known values: created_time, last_edited_time |
or | array | Optional | Filters combined with OR logic. |
or[] | JSON | Each item | A property filter or timestamp filter. |
or[] (anyOf 1) | object | Alternative | A 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).property | string | Required within parent | The name or ID of the property to filter on. |
or[] (anyOf 2) | object | Alternative | A 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).timestamp | string | Required within parent | The timestamp to filter on. Known values: created_time, last_edited_time |
Retrieve a view — response body — object view quick filters object value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Sort for the view. Can sort by property or timestamp. |
$ (anyOf 1) | Model | Alternative | Expand Retrieve a view — response body — object view / sorts / array / item / direction: ascending, descending |
$ (anyOf 2) | Model | Alternative | Expand 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