List databases (deprecated)

{
  "Result": {
    "value": "{\n  \"object\": \"list\",\n  \"results\": [\n    {\n      \"object\": \"database\",\n      \"id\": \"668d797c-76fa-4934-9b05-ad288df2d136\",\n      \"created_time\": \"2021-05-12T19:34:00.000Z\",\n      \"last_edited_time\": \"2021-05-13T04:55:00.000Z\",\n      \"parent\": {\n\t\t    \"type\": \"page_id\",\n   \t\t  \"page_id\": \"48f8fee9-cd79-4180-bc2f-ec0398253067\"\n      },\n      \"title\": [{\"type\": \"text\", \"text\": {\"content\": \"Grocery List\", \"link\": null}, \"annotations\": {\"bold\": false, \"italic\": false, \"strikethrough\": false, \"underline\": false, \"code\": false, \"color\": \"default\"}, \"plain_text\": \"Grocery List\", \"href\": null}],\n      \"icon\": {\n    \t\t\"type\": \"emoji\",\n    \t\t\"emoji\": \"🎉\"\n \t\t\t},\n  \t\t\"cover\": {\n  \t\t\t\"type\": \"external\",\n    \t\t\"external\": {\n    \t\t\t\"url\": \"https://website.domain/images/image.png\"\n    \t\t}\n  \t\t},\n      \"properties\": {\n        \"Description\": {\n          \"id\": \">otN\",\n          \"name\": \"Description\",\n          \"type\": \"rich_text\",\n          \"rich_text\": {}\n        }\n      }\n    },\n    {\n      \"object\": \"database\",\n      \"id\": \"74ba0cb2-732c-4d2f-954a-fcaa0d93a898\",\n      \"created_time\": \"2021-05-12T19:34:00.000Z\",\n      \"last_edited_time\": \"2021-05-13T04:55:00.000Z\",\n      \"parent\": {\n\t\t    \"type\": \"workspace\",\n        \"workspace\": true\n      },\n      \"title\": [{\"type\":\" text\", \"text\": {\"content\": \"Pantry\", \"link\": null}, \"annotations\": {\"bold\": false, \"italic\": false, \"strikethrough\": false, \"underline\": false, \"code\": false, \"color\": \"default\"}, \"plain_text\": \"Pantry\", \"href\": null}],\n      \"icon\": {\n    \t\t\"type\": \"emoji\",\n    \t\t\"emoji\": \"🚀\"\n \t\t\t},\n      \"cover\": null,\n      \"properties\": {\n        \"Description\": {\n          \"id\": \"Y:FB\",\n          \"name\": \"Description\",\n          \"type\": \"rich_text\",\n          \"rich_text\": {}\n        }\n      }\n    }\n  ],\n  \"next_cursor\": null,\n  \"has_more\": false\n}"
  }
}

Search pages for more details

This endpoint is deprecated and is only available on API version “2021-08-16” and earlier. Use the Search API instead. This endpoint will only return explicitly shared databases, while search will also return child pages. This endpoint’s results cannot be filtered, while search can be used to match on page title.

List all Databases shared with the authenticated integration. The response may contain fewer than page_size of results.

Database access

Integrations can only access databases a user has shared with the integration.

See Pagination for details about how to use a cursor to iterate through the list.

Integration capabilities

This endpoint requires an integration to have read content capabilities. Attempting to call this API without read content capabilities will return an HTTP response with a 403 status code. For more information on integration capabilities, see the capabilities guide.

Errors

Returns a 429 HTTP response if the request exceeds the request limits.

Query parameters

start_cursorstringOptional

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

page_sizeintegerOptionalDefaults to 100

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

Response

200

objectstringOptional

resultslist of objectsOptional

next_cursoranyOptional

has_morebooleanOptionalDefaults to true

Errors

400

Bad Request Error

Errors

Headers

Query parameters

Response

Errors