"Task completed" checkbox property value is true:
and and or keys so that multiple filters are applied at the same time. (See Query a data source for additional examples.)
The filter object
Eachfilter object contains the following fields:
| Field | Type | Description | Example value |
|---|---|---|---|
property | string | The name of the property as it appears in the data source, or the property ID. | "Task completed" |
checkboxdatefilesformulamulti_selectnumberpeoplephone_numberrelationrich_textselectstatustimestampverificationID | object | The type-specific filter condition for the query. Only types listed in the Field column of this table are supported. Refer to type-specific filter conditions for details on corresponding object values. | "checkbox": { "equals": true } |
The filter object mimics the data source filter option in the Notion UI.
Type-specific filter conditions
Checkbox
| Field | Type | Description | Example value |
|---|---|---|---|
equals | boolean | Whether a checkbox property value matches the provided value exactly.Returns or excludes all data source entries with an exact value match. | false |
does_not_equal | boolean | Whether a checkbox property value differs from the provided value.Returns or excludes all data source entries with a difference in values. | true |
Date
For the
after, before, equals, on_or_before, and on_or_after fields, if a date string with a time is provided, then the comparison is done with millisecond precision.If no timezone is provided, then the timezone defaults to UTC.date property value types and the timestamp property types created_time and last_edited_time.
The condition contains the below fields:
| Field | Type | Description | Example value |
|---|---|---|---|
after | string (ISO 8601 date) | The value to compare the date property value against. Returns data source entries where the date property value is after the provided date. | "2021-05-10" "2021-05-10T12:00:00" "2021-10-15T12:00:00-07:00" |
before | string (ISO 8601 date) | The value to compare the date property value against. Returns data source entries where the date property value is before the provided date. | "2021-05-10" "2021-05-10T12:00:00" "2021-10-15T12:00:00-07:00" |
equals | string (ISO 8601 date) | The value to compare the date property value against. Returns data source entries where the date property value is the provided date. | "2021-05-10" "2021-05-10T12:00:00" "2021-10-15T12:00:00-07:00" |
is_empty | true | The value to compare the date property value against. Returns data source entries where the date property value contains no data. | true |
is_not_empty | true | The value to compare the date property value against. Returns data source entries where the date property value is not empty. | true |
next_month | object (empty) | A filter that limits the results to data source entries where the date property value is within the next month. | {} |
next_week | object (empty) | A filter that limits the results to data source entries where the date property value is within the next week. | {} |
next_year | object (empty) | A filter that limits the results to data source entries where the date property value is within the next year. | {} |
on_or_after | string (ISO 8601 date) | The value to compare the date property value against. Returns data source entries where the date property value is on or after the provided date. | "2021-05-10" "2021-05-10T12:00:00" "2021-10-15T12:00:00-07:00" |
on_or_before | string (ISO 8601 date) | The value to compare the date property value against. Returns data source entries where the date property value is on or before the provided date. | "2021-05-10" "2021-05-10T12:00:00" "2021-10-15T12:00:00-07:00" |
past_month | object (empty) | A filter that limits the results to data source entries where the date property value is within the past month. | {} |
past_week | object (empty) | A filter that limits the results to data source entries where the date property value is within the past week. | {} |
past_year | object (empty) | A filter that limits the results to data source entries where the date property value is within the past year. | {} |
this_week | object (empty) | A filter that limits the results to data source entries where the date property value is this week. | {} |
Files
| Field | Type | Description | Example value |
|---|---|---|---|
is_empty | true | Whether the files property value does not contain any data. Returns all data source entries with an empty files property value. | true |
is_not_empty | true | Whether the files property value contains data. Returns all entries with a populated files property value. | true |
Formula
The primary field of theformula filter condition object matches the type of the formula’s result. For example, to filter a formula property that computes a checkbox, use a formula filter condition object with a checkbox field containing a checkbox filter condition as its value.
| Field | Type | Description | Example value |
|---|---|---|---|
checkbox | object | A checkbox filter condition to compare the formula result against. Returns data source entries where the formula result matches the provided condition. | Refer to the checkbox filter condition. |
date | object | A date filter condition to compare the formula result against. Returns data source entries where the formula result matches the provided condition. | Refer to the date filter condition. |
number | object | A number filter condition to compare the formula result against. Returns data source entries where the formula result matches the provided condition. | Refer to the number filter condition. |
string | object | A rich text filter condition to compare the formula result against. Returns data source entries where the formula result matches the provided condition. | Refer to the rich text filter condition. |
Multi-select
| Field | Type | Description | Example value |
|---|---|---|---|
contains | string | The value to compare the multi-select property value against. Returns data source entries where the multi-select value matches the provided string. | "Marketing" |
does_not_contain | string | The value to compare the multi-select property value against. Returns data source entries where the multi-select value does not match the provided string. | "Engineering" |
is_empty | true | Whether the multi-select property value is empty. Returns data source entries where the multi-select value does not contain any data. | true |
is_not_empty | true | Whether the multi-select property value is not empty. Returns data source entries where the multi-select value does contains data. | true |
Number
| Field | Type | Description | Example value |
|---|---|---|---|
does_not_equal | number | The number to compare the number property value against. Returns data source entries where the number property value differs from the provided number. | 42 |
equals | number | The number to compare the number property value against. Returns data source entries where the number property value is the same as the provided number. | 42 |
greater_than | number | The number to compare the number property value against. Returns data source entries where the number property value exceeds the provided number. | 42 |
greater_than_or_equal_to | number | The number to compare the number property value against. Returns data source entries where the number property value is equal to or exceeds the provided number. | 42 |
is_empty | true | Whether the number property value is empty. Returns data source entries where the number property value does not contain any data. | true |
is_not_empty | true | Whether the number property value is not empty. Returns data source entries where the number property value contains data. | true |
less_than | number | The number to compare the number property value against. Returns data source entries where the number property value is less than the provided number. | 42 |
less_than_or_equal_to | number | The number to compare the number property value against. Returns data source entries where the number property value is equal to or is less than the provided number. | 42 |
People
You can apply a people filter condition topeople, created_by, and last_edited_by data source property types.
The people filter condition contains the following fields:
| Field | Type | Description | Example value |
|---|---|---|---|
contains | string (UUIDv4) | The value to compare the people property value against. Returns data source entries where the people property value contains the provided string. | "6c574cee-ca68-41c8-86e0-1b9e992689fb" |
does_not_contain | string (UUIDv4) | The value to compare the people property value against. Returns data source entries where the people property value does not contain the provided string. | "6c574cee-ca68-41c8-86e0-1b9e992689fb" |
is_empty | true | Whether the people property value does not contain any data. Returns data source entries where the people property value does not contain any data. | true |
is_not_empty | true | Whether the people property value contains data. Returns data source entries where the people property value is not empty. | true |
Relation
| Field | Type | Description | Example value |
|---|---|---|---|
contains | string (UUIDv4) | The value to compare the relation property value against. Returns data source entries where the relation property value contains the provided string. | "6c574cee-ca68-41c8-86e0-1b9e992689fb" |
does_not_contain | string (UUIDv4) | The value to compare the relation property value against. Returns entries where the relation property value does not contain the provided string. | "6c574cee-ca68-41c8-86e0-1b9e992689fb" |
is_empty | true | Whether the relation property value does not contain data. Returns data source entries where the relation property value does not contain any data. | true |
is_not_empty | true | Whether the relation property value contains data. Returns data source entries where the property value is not empty. | true |
Rich text
| Field | Type | Description | Example value |
|---|---|---|---|
contains | string | The string to compare the text property value against. Returns data source entries with a text property value that includes the provided string. | "Moved to Q2" |
does_not_contain | string | The string to compare the text property value against. Returns data source entries with a text property value that does not include the provided string. | "Moved to Q2" |
does_not_equal | string | The string to compare the text property value against. Returns data source entries with a text property value that does not match the provided string. | "Moved to Q2" |
ends_with | string | The string to compare the text property value against. Returns data source entries with a text property value that ends with the provided string. | "Q2" |
equals | string | The string to compare the text property value against. Returns data source entries with a text property value that matches the provided string. | "Moved to Q2" |
is_empty | true | Whether the text property value does not contain any data. Returns data source entries with a text property value that is empty. | true |
is_not_empty | true | Whether the text property value contains any data. Returns data source entries with a text property value that contains data. | true |
starts_with | string | The string to compare the text property value against. Returns data source entries with a text property value that starts with the provided string. | ”Moved” |
Rollup
A rollup data source property can evaluate to an array, date, or number value. The filter condition for the rollup property contains arollup key and a corresponding object value that depends on the computed value type.
Filter conditions for array rollup values
| Field | Type | Description | Example value |
|---|---|---|---|
any | object | The value to compare each rollup property value against. Can be a filter condition for any other type. Returns data source entries where the rollup property value matches the provided criteria. | "rich_text": { "contains": "Take Fig on a walk" } |
every | object | The value to compare each rollup property value against. Can be a filter condition for any other type. Returns data source entries where every rollup property value matches the provided criteria. | "rich_text": { "contains": "Take Fig on a walk" } |
none | object | The value to compare each rollup property value against. Can be a filter condition for any other type. Returns data source entries where no rollup property value matches the provided criteria. | "rich_text": { "contains": "Take Fig on a walk" } |
Filter conditions for date rollup values
A rollup value is stored as a date only if the “Earliest date”, “Latest date”, or “Date range” computation is selected for the property in the Notion UI.
Filter conditions for number rollup values
Select
| Field | Type | Description | Example value |
|---|---|---|---|
equals | string | The string to compare the select property value against. Returns data source entries where the select property value matches the provided string. | "This week" |
does_not_equal | string | The string to compare the select property value against. Returns data source entries where the select property value does not match the provided string. | "Backlog" |
is_empty | true | Whether the select property value does not contain data. Returns data source entries where the select property value is empty. | true |
is_not_empty | true | Whether the select property value contains data. Returns data source entries where the select property value is not empty. | true |
Status
| Field | Type | Description | Example value |
|---|---|---|---|
| equals | string | The string to compare the status property value against. Returns data source entries where the status property value matches the provided string. | ”This week” |
| does_not_equal | string | The string to compare the status property value against. Returns data source entries where the status property value does not match the provided string. | ”Backlog” |
| is_empty | true | Whether the status property value does not contain data. Returns data source entries where the status property value is empty. | true |
| is_not_empty | true | Whether the status property value contains data. Returns data source entries where the status property value is not empty. | true |
Timestamp
Use a timestamp filter condition to filter results based oncreated_time or last_edited_time values.
| Field | Type | Description | Example value |
|---|---|---|---|
| timestamp | created_time last_edited_time | A constant string representing the type of timestamp to use as a filter. | ”created_time” |
| created_time last_edited_time | object | A date filter condition used to filter the specified timestamp. | Refer to the date filter condition. |
Verification
| Field | Type | Description | Example value |
|---|---|---|---|
| status | string | The verification status being queried. Valid options are: verified, expired, none Returns data source entries where the current verification status matches the queried status. | ”verified” |
ID
Use a timestamp filter condition to filter results based on theunique_id value.
| Field | Type | Description | Example value |
|---|---|---|---|
does_not_equal | number | The value to compare the unique_id property value against. Returns data source entries where the unique_id property value differs from the provided value. | 42 |
equals | number | The value to compare the unique_id property value against. Returns data source entries where the unique_id property value is the same as the provided value. | 42 |
greater_than | number | The value to compare the unique_id property value against. Returns data source entries where the unique_id property value exceeds the provided value. | 42 |
greater_than_or_equal_to | number | The value to compare the unique_id property value against. Returns data source entries where the unique_id property value is equal to or exceeds the provided value. | 42 |
less_than | number | The value to compare the unique_id property value against. Returns data source entries where the unique_id property value is less than the provided value. | 42 |
less_than_or_equal_to | number | The value to compare the unique_id property value against. Returns data source entries where the unique_id property value is equal to or is less than the provided value. | 42 |
Compound filter conditions
You can use a compound filter condition to limit the results of a data source query based on multiple conditions. This mimics filter chaining in the Notion UI.
and or or key with a value that is an array of filter objects or nested compound filter objects. Nesting is supported up to two levels deep.
| Field | Type | Description | Example value |
|---|---|---|---|
and | array | An array of filter objects or compound filter conditions. Returns data source entries that match all of the provided filter conditions. | Refer to the examples below. |
| or | array | An array of filter objects or compound filter conditions. Returns data source entries that match any of the provided filter conditions | Refer to the examples below. |