POST /v1/databases/{database_id}/query

Query a database

Servers

Path parameters

Name Type Required Description
database_id String Yes

Identifier for a Notion database.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
filter_properties[] Array No

A list of page property value IDs associated with the database. Use this param to limit the response to a specific page property value or values for pages that meet the filter criteria.

Request body fields

Name Type Required Description
start_cursor String No

When supplied, returns a page of results starting after the cursor provided. If not supplied, this endpoint will return the first page of results.

sorts[] Array No

When supplied, orders the results based on the provided sort criteria.

sorts[].direction String Yes

Valid values:

  • "ascending"
  • "descending"
sorts[].property String Yes
archived Boolean No
filter Object No

When supplied, limits which pages are returned based on the filter conditions.

page_size Integer No

The number of items from the full list desired in the response. Maximum: 100

Default value: 100

in_trash Boolean No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.