Search by title

POST

https://api.notion.com/v1/search

POST

/v1/search

curl -X POST 'https://api.notion.com/v1/search' \
  -H 'Authorization: Bearer '"$NOTION_API_KEY"'' \
  -H 'Content-Type: application/json' \
  -H 'Notion-Version: 2022-06-28' \
  --data '{
    "query":"External tasks",
    "filter": {
        "value": "database",
        "property": "object"
    },
    "sort":{
      "direction":"ascending",
      "timestamp":"last_edited_time"
    }
  }'

{
  "object": "list",
  "results": [
    {
      "object": "page",
      "id": "954b67f9-3f87-41db-8874-23b92bbd31ee",
      "created_time": "2022-07-06T19:30:00.000Z",
      "last_edited_time": "2022-07-06T19:30:00.000Z",
      "created_by": {
        "object": "user",
        "id": "ee5f0f84-409a-440f-983a-a5315961c6e4"
      },
      "last_edited_by": {
        "object": "user",
        "id": "ee5f0f84-409a-440f-983a-a5315961c6e4"
      },
      "cover": {
        "type": "external",
        "external": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/6/62/Tuscankale.jpg"
        }
      },
      "icon": {
        "type": "emoji",
        "emoji": "🥬"
      },
      "parent": {
        "type": "database_id",
        "database_id": "d9824bdc-8445-4327-be8b-5b47500af6ce"
      },
      "archived": false,
      "properties": {
        "Store availability": {
          "id": "%3AUPp",
          "type": "multi_select",
          "multi_select": []
        },
        "Food group": {
          "id": "A%40Hk",
          "type": "select",
          "select": {
            "id": "5e8e7e8f-432e-4d8a-8166-1821e10225fc",
            "name": "🥬 Vegetable",
            "color": "pink"
          }
        },
        "Price": {
          "id": "BJXS",
          "type": "number",
          "number": {}
        },
        "Responsible Person": {
          "id": "Iowm",
          "type": "people",
          "people": []
        },
        "Last ordered": {
          "id": "Jsfb",
          "type": "date",
          "date": {}
        },
        "Cost of next trip": {
          "id": "WOd%3B",
          "type": "formula",
          "formula": {
            "type": "number",
            "number": {}
          }
        },
        "Recipes": {
          "id": "YfIu",
          "type": "relation",
          "relation": []
        },
        "Description": {
          "id": "_Tc_",
          "type": "rich_text",
          "rich_text": [
            {
              "type": "text",
              "text": {
                "content": "A dark green leafy vegetable",
                "link": {}
              },
              "annotations": {
                "bold": false,
                "italic": false,
                "strikethrough": false,
                "underline": false,
                "code": false,
                "color": "default"
              },
              "plain_text": "A dark green leafy vegetable",
              "href": {}
            }
          ]
        },
        "In stock": {
          "id": "%60%5Bq%3F",
          "type": "checkbox",
          "checkbox": false
        },
        "Number of meals": {
          "id": "zag~",
          "type": "rollup",
          "rollup": {
            "type": "number",
            "number": 0,
            "function": "count"
          }
        },
        "Photo": {
          "id": "%7DF_L",
          "type": "url",
          "url": {}
        },
        "Name": {
          "id": "title",
          "type": "title",
          "title": [
            {
              "type": "text",
              "text": {
                "content": "Tuscan kale",
                "link": {}
              },
              "annotations": {
                "bold": false,
                "italic": false,
                "strikethrough": false,
                "underline": false,
                "code": false,
                "color": "default"
              },
              "plain_text": "Tuscan kale",
              "href": {}
            }
          ]
        }
      },
      "url": "https://www.notion.so/Tuscan-kale-954b67f93f8741db887423b92bbd31ee"
    },
    {
      "object": "page",
      "id": "59833787-2cf9-4fdf-8782-e53db20768a5",
      "created_time": "2022-03-01T19:05:00.000Z",
      "last_edited_time": "2022-07-06T20:25:00.000Z",
      "created_by": {
        "object": "user",
        "id": "ee5f0f84-409a-440f-983a-a5315961c6e4"
      },
      "last_edited_by": {
        "object": "user",
        "id": "0c3e9826-b8f7-4f73-927d-2caaf86f1103"
      },
      "cover": {
        "type": "external",
        "external": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/6/62/Tuscankale.jpg"
        }
      },
      "icon": {
        "type": "emoji",
        "emoji": "🥬"
      },
      "parent": {
        "type": "database_id",
        "database_id": "d9824bdc-8445-4327-be8b-5b47500af6ce"
      },
      "archived": false,
      "properties": {
        "Store availability": {
          "id": "%3AUPp",
          "type": "multi_select",
          "multi_select": [
            "string",
            "string"
          ]
        },
        "Food group": {
          "id": "A%40Hk",
          "type": "select",
          "select": {
            "id": "5e8e7e8f-432e-4d8a-8166-1821e10225fc",
            "name": "🥬 Vegetable",
            "color": "pink"
          }
        },
        "Price": {
          "id": "BJXS",
          "type": "number",
          "number": 2.5
        },
        "Responsible Person": {
          "id": "Iowm",
          "type": "people",
          "people": [
            "string"
          ]
        },
        "Last ordered": {
          "id": "Jsfb",
          "type": "date",
          "date": {
            "start": "2022-02-22",
            "end": null,
            "time_zone": null
          }
        },
        "Cost of next trip": {
          "id": "WOd%3B",
          "type": "formula",
          "formula": {
            "type": "number",
            "number": 0
          }
        },
        "Recipes": {
          "id": "YfIu",
          "type": "relation",
          "relation": [
            "string",
            "string"
          ],
          "has_more": false
        },
        "Description": {
          "id": "_Tc_",
          "type": "rich_text",
          "rich_text": [
            {
              "type": "text",
              "text": {
                "content": "A dark ",
                "link": {}
              },
              "annotations": {
                "bold": false,
                "italic": false,
                "strikethrough": false,
                "underline": false,
                "code": false,
                "color": "default"
              },
              "plain_text": "A dark ",
              "href": {}
            },
            {
              "type": "text",
              "text": {
                "content": "green",
                "link": {}
              },
              "annotations": {
                "bold": false,
                "italic": false,
                "strikethrough": false,
                "underline": false,
                "code": false,
                "color": "green"
              },
              "plain_text": "green",
              "href": {}
            },
            {
              "type": "text",
              "text": {
                "content": " leafy vegetable",
                "link": {}
              },
              "annotations": {
                "bold": false,
                "italic": false,
                "strikethrough": false,
                "underline": false,
                "code": false,
                "color": "default"
              },
              "plain_text": " leafy vegetable",
              "href": {}
            }
          ]
        },
        "In stock": {
          "id": "%60%5Bq%3F",
          "type": "checkbox",
          "checkbox": true
        },
        "Number of meals": {
          "id": "zag~",
          "type": "rollup",
          "rollup": {
            "type": "number",
            "number": 2,
            "function": "count"
          }
        },
        "Photo": {
          "id": "%7DF_L",
          "type": "url",
          "url": "https://i.insider.com/612fb23c9ef1e50018f93198?width=1136&format=jpeg"
        },
        "Name": {
          "id": "title",
          "type": "title",
          "title": [
            {
              "type": "text",
              "text": {
                "content": "Tuscan kale",
                "link": {}
              },
              "annotations": {
                "bold": false,
                "italic": false,
                "strikethrough": false,
                "underline": false,
                "code": false,
                "color": "default"
              },
              "plain_text": "Tuscan kale",
              "href": {}
            }
          ]
        }
      },
      "url": "https://www.notion.so/Tuscan-kale-598337872cf94fdf8782e53db20768a5"
    }
  ],
  "next_cursor": {},
  "has_more": false,
  "type": "page_or_database",
  "page_or_database": {}
}

Searches all parent or child pages and databases that have been shared with an integration.

Returns all pages or databases, excluding duplicated linked databases, that have titles that include the query param. If no query param is provided, then the response contains all pages or databases that have been shared with the integration. The results adhere to any limitations related to an integration’s capabilities.

To limit the request to search only pages or to search only databases, use the filter param.

Errors

Each Public API endpoint can return several possible error codes. See the Error codes section of the Status codes documentation for more information.

The Search endpoint supports pagination. To learn more about working with paginated responses, see the pagination section of the Notion API Introduction.

To search a specific database — not all databases shared with the integration — use the Query a database endpoint instead.

Request

This endpoint expects an object.

querystringOptional

The text that the API compares page and database titles against.

sortobjectOptional

A set of criteria, direction and timestamp keys, that orders the results. The only supported timestamp value is "last_edited_time". Supported direction values are "ascending" and "descending". If sort is not provided, then the most recently edited results are returned first.

filterobjectOptional

A set of criteria, value and property keys, that limits the results to either only pages or only databases. Possible value values are "page" or "database". The only supported property value is "object".

start_cursorstringOptional

A cursor value returned in a previous response that If supplied, limits the response to results starting after the cursor. If not supplied, then the first page of results is returned. Refer to pagination for more details.

page_sizeintegerOptionalDefaults to 100

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

Response

200

objectstringOptional

resultslist of objectsOptional

next_cursoranyOptional

has_morebooleanOptionalDefaults to true

typestringOptional

page_or_databaseobjectOptional

Errors

400

Bad Request Error

429

Too Many Requests Error

Errors

Headers

Request

Response

Errors