API endpoints
Notion API endpoints.
BlocksChildrenEndpoint
Bases: Endpoint
Source code in notion_client/api_endpoints.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
|
append(block_id, **kwargs)
Create and append new children blocks to the block using the ID specified.
Source code in notion_client/api_endpoints.py
18 19 20 21 22 23 24 25 26 27 28 |
|
list(block_id, **kwargs)
Return a paginated array of child block objects contained in the block.
Source code in notion_client/api_endpoints.py
30 31 32 33 34 35 36 37 38 39 40 |
|
BlocksEndpoint
Bases: Endpoint
Source code in notion_client/api_endpoints.py
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
|
delete(block_id, **kwargs)
Set a Block object, including page blocks, to archived: true
.
Source code in notion_client/api_endpoints.py
101 102 103 104 105 106 107 108 109 110 |
|
retrieve(block_id, **kwargs)
Retrieve a Block object using the ID specified.
Source code in notion_client/api_endpoints.py
48 49 50 51 52 53 54 55 |
|
update(block_id, **kwargs)
Update the content for the specified block_id
based on the block type.
Source code in notion_client/api_endpoints.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
|
CommentsEndpoint
Bases: Endpoint
Source code in notion_client/api_endpoints.py
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 |
|
create(**kwargs)
Create a new comment in the specified page or existing discussion thread.
Source code in notion_client/api_endpoints.py
305 306 307 308 309 310 311 312 313 314 315 |
|
list(**kwargs)
Retrieve a list of un-resolved Comment objects from the specified block.
Source code in notion_client/api_endpoints.py
317 318 319 320 321 322 323 324 325 326 327 |
|
DatabasesEndpoint
Bases: Endpoint
Source code in notion_client/api_endpoints.py
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
|
create(**kwargs)
Create a database as a subpage in the specified parent page.
Source code in notion_client/api_endpoints.py
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
|
list(**kwargs)
List all Databases shared with the authenticated integration.
⚠️ Deprecated endpoint
Source code in notion_client/api_endpoints.py
114 115 116 117 118 119 120 121 122 123 124 125 126 |
|
query(database_id, **kwargs)
Get a list of Pages contained in the database.
Source code in notion_client/api_endpoints.py
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
|
retrieve(database_id, **kwargs)
Retrieve a Database object using the ID specified.
Source code in notion_client/api_endpoints.py
149 150 151 152 153 154 155 156 |
|
update(database_id, **kwargs)
Update an existing database as specified by the parameters.
Source code in notion_client/api_endpoints.py
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
|
PagesEndpoint
Bases: Endpoint
Source code in notion_client/api_endpoints.py
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
|
create(**kwargs)
Create a new page in the specified database or as a child of an existing page.
Source code in notion_client/api_endpoints.py
221 222 223 224 225 226 227 228 229 230 231 |
|
retrieve(page_id, **kwargs)
Retrieve a Page object using the ID specified.
Source code in notion_client/api_endpoints.py
233 234 235 236 237 238 239 240 241 242 243 |
|
update(page_id, **kwargs)
Update page property values for the specified page.
Source code in notion_client/api_endpoints.py
245 246 247 248 249 250 251 252 253 254 255 |
|
PagesPropertiesEndpoint
Bases: Endpoint
Source code in notion_client/api_endpoints.py
202 203 204 205 206 207 208 209 210 211 212 213 |
|
retrieve(page_id, property_id, **kwargs)
Retrieve a property_item
object for a given page_id
and property_id
.
Source code in notion_client/api_endpoints.py
203 204 205 206 207 208 209 210 211 212 213 |
|
SearchEndpoint
Bases: Endpoint
Source code in notion_client/api_endpoints.py
290 291 292 293 294 295 296 297 298 299 300 301 |
|
__call__(**kwargs)
Search all pages and child pages that are shared with the integration.
Source code in notion_client/api_endpoints.py
291 292 293 294 295 296 297 298 299 300 301 |
|
UsersEndpoint
Bases: Endpoint
Source code in notion_client/api_endpoints.py
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
|
list(**kwargs)
Return a paginated list of Users for the workspace.
Source code in notion_client/api_endpoints.py
259 260 261 262 263 264 265 266 267 268 269 |
|
me(**kwargs)
Retrieve the bot User associated with the API token.
Source code in notion_client/api_endpoints.py
280 281 282 283 284 285 286 287 |
|
retrieve(user_id, **kwargs)
Retrieve a User using the ID specified.
Source code in notion_client/api_endpoints.py
271 272 273 274 275 276 277 278 |
|