データベースを取得
GET/v1/databases/{database_id}提供されたデータベースIDについて、データベースの構造と列を記述する情報であるデータベースオブジェクトを取得します。応答は、統合の機能に対する制限に準拠しています。
Requestパラメータ
Pathパラメータ
database_id
string
必須
Notionデータベースの識別子。
Headerパラメータ
Notion-Version
string
必須
サンプルコード
Response
200 Success - Retrieve a database(200)
レコードが存在しない(404)
レート制限(429)
200 Success - Retrieve a database
HTTPステータスコード: 200
コンテンツ形式: JSONapplication/json
データ構造
created_time
string
必須
id
string
必須
last_edited_time
string
必須
object
string
必須
properties
object
必須
Author
object
可選
Link
object
可選
Name
object
必須
Publisher
object
可選
Publishing/Release Date
object
可選
Read
object
可選
Score /5
object
可選
Status
object
可選
Summary
object
可選
Type
object
可選
+1
object
必須
In stock
object
必須
Price
object
必須
Description
object
必須
Last ordered
object
必須
Meals
object
必須
Number of meals
object
必須
Store availability
object
必須
Photo
object
必須
Food group
object
必須
title
array [object {5}]
必須
annotations
object
可選
href
null
可選
plain_text
string
可選
text
object
可選
type
string
可選
icon
object
必須
type
string
必須
emoji
string
必須
cover
object
必須
type
string
必須
external
object
必須
url
string
必須
description
array [object {5}]
必須
type
string
可選
text
object
可選
annotations
object
可選
plain_text
string
可選
href
null
可選
parent
object
必須
type
string
必須
page_id
string
必須
archived
boolean
必須
is_inline
boolean
必須
例200 Success - Retrieve a database
{
"object": "database",
"id": "bc1211ca-e3f1-4939-ae34-5260b16f627c",
"created_time": "2021-07-08T23:50:00.000Z",
"last_edited_time": "2021-07-08T23:50:00.000Z",
"icon": {
"type": "emoji",
"emoji": "🎉"
},
"cover": {
"type": "external",
"external": {
"url": "https://website.domain/images/image.png"
}
},
"url": "https://www.notion.so/bc1211cae3f14939ae34260b16f627c",
"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
}
],
"description": [
{
"type": "text",
"text": {
"content": "Grocery list for just kale 🥬",
"link": null
},
"annotations": {
"bold": false,
"italic": false,
"strikethrough": false,
"underline": false,
"code": false,
"color": "default"
},
"plain_text": "Grocery list for just kale 🥬",
"href": null
}
],
"properties": {
"+1": {
"id": "Wp%3DC",
"name": "+1",
"type": "people",
"people": {}
},
"In stock": {
"id": "fk%5EY",
"name": "In stock",
"type": "checkbox",
"checkbox": {}
},
"Price": {
"id": "evWq",
"name": "Price",
"type": "number",
"number": {
"format": "dollar"
}
},
"Description": {
"id": "V}lX",
"name": "Description",
"type": "rich_text",
"rich_text": {}
},
"Last ordered": {
"id": "eVnV",
"name": "Last ordered",
"type": "date",
"date": {}
},
"Meals": {
"id": "%7DWA~",
"name": "Meals",
"type": "relation",
"relation": {
"database_id": "668d797c-76fa-4934-9b05-ad288df2d136",
"synced_property_name": "Related to Grocery List (Meals)"
}
},
"Number of meals": {
"id": "Z\\Eh",
"name": "Number of meals",
"type": "rollup",
"rollup": {
"rollup_property_name": "Name",
"relation_property_name": "Meals",
"rollup_property_id": "title",
"relation_property_id": "mxp^",
"function": "count"
}
},
"Store availability": {
"id": "s}Kq",
"name": "Store availability",
"type": "multi_select",
"multi_select": {
"options": [
{
"id": "cb79b393-d1c1-4528-b517-c450859de766",
"name": "Duc Loi Market",
"color": "blue"
},
{
"id": "58aae162-75d4-403b-a793-3bc7308e4cd2",
"name": "Rainbow Grocery",
"color": "gray"
},
{
"id": "22d0f199-babc-44ff-bd80-a9eae3e3fcbf",
"name": "Nijiya Market",
"color": "purple"
},
{
"id": "0d069987-ffb0-4347-bde2-8e4068003dbc",
"name": "Gus's Community Market",
"color": "yellow"
}
]
}
},
"Photo": {
"id": "yfiK",
"name": "Photo",
"type": "files",
"files": {}
},
"Food group": {
"id": "CM%3EH",
"name": "Food group",
"type": "select",
"select": {
"options": [
{
"id": "6d4523fa-88cb-4ffd-9364-1e39d0f4e566",
"name": "🥦Vegetable",
"color": "green"
},
{
"id": "268d7e75-de8f-4c4b-8b9d-de0f97021833",
"name": "🍎Fruit",
"color": "red"
},
{
"id": "1b234a00-dc97-489c-b987-829264cfdfef",
"name": "💪Protein",
"color": "yellow"
}
]
}
},
"Name": {
"id": "title",
"name": "Name",
"type": "title",
"title": {}
}
},
"parent": {
"type": "page_id",
"page_id": "98ad959b-2b6a-4774-80ee-00246fb0ea9b"
},
"archived": false,
"is_inline": false
}最終更新： 2 years ago