Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.notion.com/reference/post-database-query-filter below:

Filter database entries

When you query a database, you can send a filter object in the body of the request that limits the returned entries based on the specified criteria.

For example, the below query limits the response to entries where the "Task completed" checkbox property value is true:

curl -X POST 'https://api.notion.com/v1/databases/897e5a76ae524b489fdfe71f5945d1af/query' \
  -H 'Authorization: Bearer '"$NOTION_API_KEY"'' \
  -H 'Notion-Version: 2022-06-28' \
  -H "Content-Type: application/json" \
--data '{
  "filter": {
    "property": "Task completed",
    "checkbox": {
        "equals": true
   }
  }
}'

Here is the same query using the Notion SDK for JavaScript:

const { Client } = require('@notionhq/client');

const notion = new Client({ auth: process.env.NOTION_API_KEY });
// replace with your own database ID
const databaseId = 'd9824bdc-8445-4327-be8b-5b47500af6ce';

const filteredRows = async () => {
	const response = await notion.databases.query({
	  database_id: databaseId,
	  filter: {
	    property: "Task completed",
	    checkbox: {
	      equals: true
	    }
	  },
	});
  return response;
}

Filters can be chained with the and and or keys so that multiple filters are applied at the same time. (See Query a database for additional examples.)

{
  "and": [
    {
      "property": "Done",
      "checkbox": {
        "equals": true
      }
    }, 
    {
      "or": [
        {
          "property": "Tags",
          "contains": "A"
        },
        {
          "property": "Tags",
          "contains": "B"
        }
      ]
    }
  ]
}

If no filter is provided, all the pages in the database will be returned with pagination.

Each filter object contains the following fields:

Refer to type-specific filter conditions for details on corresponding object values.

{
  "filter": {
    "property": "Task completed",
    "checkbox": {
      "equals": true
    }
  }
}

👍

The filter object mimics the database filter option in the Notion UI.

Returns or excludes all database entries with an exact value match.

Returns or excludes all database entries with a difference in values.

{
  "filter": {
    "property": "Task completed",
    "checkbox": {
      "does_not_equal": true
    }
  }
}

📘

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.

A date filter condition can be used to limit date property value types and the timestamp property types created_time and last_edited_time.

The condition contains the below fields:

Returns database entries where the date property value is after the provided date.

"2021-05-10T12:00:00"

"2021-10-15T12:00:00-07:00"

Returns database entries where the date property value is before the provided date.

"2021-05-10T12:00:00"

"2021-10-15T12:00:00-07:00"

Returns database entries where the date property value is the provided date.

"2021-05-10T12:00:00"

"2021-10-15T12:00:00-07:00"

Returns database entries where the date property value contains no data.

Returns database entries where the date property value is not empty.

Returns database entries where the date property value is on or after the provided date.

"2021-05-10T12:00:00"

"2021-10-15T12:00:00-07:00"

Returns database entries where the date property value is on or before the provided date.

"2021-05-10T12:00:00"

"2021-10-15T12:00:00-07:00"

{
  "filter": {
    "property": "Due date",
    "date": {
      "on_or_after": "2023-02-08"
    }
  }
}

Returns all database entries with an empty files property value.

Returns all entries with a populated files property value.

{
  "filter": {
    "property": "Blueprint",
    "files": {
      "is_not_empty": true
    }
  }
}

The primary field of the formula 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.

Returns database entries where the formula result matches the provided condition.

Returns database entries where the formula result matches the provided condition.

Returns database entries where the formula result matches the provided condition.

Returns database entries where the formula result matches the provided condition.

{
  "filter": {
    "property": "One month deadline",
    "formula": {
      "date":{
          "after": "2021-05-10"
      }
    }
  }
}

Returns database entries where the multi-select value matches the provided string.

Returns database entries where the multi-select value does not match the provided string.

Returns database entries where the multi-select value does not contain any data.

Returns database entries where the multi-select value does contains data.

{
  "filter": {
    "property": "Programming language",
    "multi_select": {
      "contains": "TypeScript"
    }
  }
}

Returns database entries where the number property value differs from the provided number.

Returns database entries where the number property value is the same as the provided number.

Returns database entries where the number property value exceeds the provided number.

Returns database entries where the number property value is equal to or exceeds the provided number.

Returns database entries where the number property value does not contain any data.

Returns database entries where the number property value contains data.

Returns database entries where the number property value is less than the provided number.

Returns database entries where the number property value is equal to or is less than the provided number.

{
  "filter": {
    "property": "Estimated working days",
    "number": {
      "less_than_or_equal_to": 5
    }
  }
}

You can apply a people filter condition to people, created_by, and last_edited_by database property types.

The people filter condition contains the following fields:

Returns database entries where the people property value contains the provided string.

Returns database entries where the people property value does not contain the provided string.

Returns database entries where the people property value does not contain any data.

Returns database entries where the people property value is not empty.

{
  "filter": {
    "property": "Last edited by",
    "people": {
      "contains": "c2f20311-9e54-4d11-8c79-7398424ae41e"
    }
  }
}

Returns database entries where the relation property value contains the provided string.

Returns entries where the relation property value does not contain the provided string.

Returns database entries where the relation property value does not contain any data.

Returns database entries where the property value is not empty.

{
  "filter": {
    "property": "✔️ Task List",
    "relation": {
      "contains": "0c1f7cb280904f18924ed92965055e32"
    }
  }
}

Returns database entries with a text property value that includes the provided string.

Returns database entries with a text property value that does not include the provided string.

Returns database entries with a text property value that does not match the provided string.

Returns database entries with a text property value that ends with the provided string.

Returns database entries with a text property value that matches the provided string.

Returns database entries with a text property value that is empty.

Returns database entries with a text property value that contains data.

Returns database entries with a text property value that starts with the provided string.

{
  "filter": {
    "property": "Description",
    "rich_text": {
      "contains": "cross-team"
    }
  }
}

A rollup database property can evaluate to an array, date, or number value. The filter condition for the rollup property contains a rollup key and a corresponding object value that depends on the computed value type.

Returns database entries where the rollup property value matches the provided criteria.

Returns database entries where every rollup property value matches the provided criteria.

Returns database entries where no rollup property value matches the provided criteria.

{
  "filter": {
    "property": "Related tasks",
    "rollup": {
      "any": {
        "rich_text": {
          "contains": "Migrate database"
        }
      }
    }
  }
}

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.

Returns database entries where the rollup value matches the provided condition.

{
  "filter": {
    "property": "Parent project due date",
    "rollup": {
      "date": {
        "on_or_before": "2023-02-08"
      }
    }
  }
}

Returns database entries where the rollup value matches the provided condition.

{
  "filter": {
    "property": "Total estimated working days",
    "rollup": {
      "number": {
        "does_not_equal": 42
      }
    }
  }
}

Returns database entries where the select property value matches the provided string.

Returns database entries where the select property value does not match the provided string.

Returns database entries where the select property value is empty.

Returns database entries where the select property value is not empty.

{
  "filter": {
    "property": "Frontend framework",
    "select": {
      "equals": "React"
    }
  }
}

Returns database entries where the status property value matches the provided string.

Returns database entries where the status property value does not match the provided string.

Returns database entries where the status property value is empty.

Returns database entries where the status property value is not empty.

{
  "filter": {
    "property": "Project status",
    "status": {
      "equals": "Not started"
    }
  }
}

Use a timestamp filter condition to filter results based on created_time or last_edited_time values.

{
  "filter": {
    "timestamp": "created_time",
    "created_time": {
      "on_or_before": "2022-10-13"
    }
  }
}

🚧

The timestamp filter condition does not require a property name. The API throws an error if you provide one.

Use a timestamp filter condition to filter results based on the unique_id value.

Returns database entries where the unique_id property value differs from the provided value.

Returns database entries where the unique_id property value is the same as the provided value.

Returns database entries where the unique_id property value exceeds the provided value.

Returns database entries where the unique_id property value is equal to or exceeds the provided value.

Returns database entries where the unique_id property value is less than the provided value.

Returns database entries where the unique_id property value is equal to or is less than the provided value.

{
  "filter": {
    "and": [
      {
        "property": "ID",
        "unique_id": {
          "greater_than": 1
        }
      },
      {
        "property": "ID",
        "unique_id": {
          "less_than": 3
        }
      }
    ]
  }
}

You can use a compound filter condition to limit the results of a database query based on multiple conditions. This mimics filter chaining in the Notion UI.

An example filter chain in the Notion UI

The above filters in the Notion UI are equivalent to the following compound filter condition via the API:

{
  "and": [
    {
      "property": "Done",
      "checkbox": {
        "equals": true
      }
    }, 
    {
      "or": [
        {
          "property": "Tags",
          "contains": "A"
        },
        {
          "property": "Tags",
          "contains": "B"
        }
      ]
    }
  ]
}

A compound filter condition contains an 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.

Returns database entries that match all of the provided filter conditions.

Returns database entries that match any of the provided filter conditions

{
  "filter": {
    "and": [
      {
        "property": "Complete",
        "checkbox": {
          "equals": true
        }
      },
      {
        "property": "Working days",
        "number": {
          "greater_than": 10
        }
      }
    ]
  }
}

{
  "filter": {
    "or": [
      {
        "property": "Description",
        "rich_text": {
          "contains": "2023"
        }
      },
      {
        "and": [
          {
            "property": "Department",
            "select": {
              "equals": "Engineering"
            }
          },
          {
            "property": "Priority goal",
            "checkbox": {
              "equals": true
            }
          }
        ]
      }
    ]
  }
}

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4