Overview
- GET /v1/users/{id}
- PARAMETERS /v1/users/{id}
- GET /v1/users
- GET /v1/users/me
- GET /v1/databases/{id}
- PATCH /v1/databases/{id}
- PARAMETERS /v1/databases/{id}
- POST /v1/databases/{id}/query
- PARAMETERS /v1/databases/{id}/query
- POST /v1/databases/
- POST /v1/pages/
- GET /v1/pages/{id}
- PATCH /v1/pages/{id}
- PARAMETERS /v1/pages/{id}
- GET /v1/pages/{page_id}/properties/{property_id}
- PARAMETERS /v1/pages/{page_id}/properties/{property_id}
- GET /v1/blocks/{id}/children
- PATCH /v1/blocks/{id}/children
- PARAMETERS /v1/blocks/{id}/children
- GET /v1/blocks/{id}
- DELETE /v1/blocks/{id}
- PATCH /v1/blocks/{id}
- PARAMETERS /v1/blocks/{id}
- POST /v1/search
- GET /v1/comments
- POST /v1/comments
GET /v1/users/{id}
Summary: Retrieve a user
Retrieve a user object using the ID specified in the request path.
OpenAPI snippet URL
PARAMETERS /v1/users/{id}
OpenAPI snippet URL
GET /v1/users
Summary: List all users
Returns a paginated list of user objects for a workspace
OpenAPI snippet URL
GET /v1/users/me
Summary: Retrieve your token’s bot user
Retrieve your token’s bot user
OpenAPI snippet URL
GET /v1/databases/{id}
Summary: Retrieve a database
Retrieves a database object using the ID specified in the request path.
OpenAPI snippet URL
PATCH /v1/databases/{id}
Summary: Update a database
Update a database
OpenAPI snippet URL
PARAMETERS /v1/databases/{id}
OpenAPI snippet URL
POST /v1/databases/{id}/query
Summary: Query a database
Query a database
OpenAPI snippet URL
PARAMETERS /v1/databases/{id}/query
OpenAPI snippet URL
POST /v1/databases/
Summary: Create a database
Create a database
OpenAPI snippet URL
POST /v1/pages/
Summary: Create a page
Create a page
OpenAPI snippet URL
GET /v1/pages/{id}
Summary: Retrieve a page
Retrieves a Page object using the ID in the request path. This endpoint exposes page properties, not page content.
OpenAPI snippet URL
PATCH /v1/pages/{id}
Summary: Update page properties
Updates a page by setting the values of any properties specified in the JSON body of the request. Properties not updated via parameters will remain unchanged.
OpenAPI snippet URL
PARAMETERS /v1/pages/{id}
OpenAPI snippet URL
GET /v1/pages/{page_id}/properties/{property_id}
Summary: Retrieve a page property item
Retrieve a page property item
OpenAPI snippet URL
PARAMETERS /v1/pages/{page_id}/properties/{property_id}
OpenAPI snippet URL
GET /v1/blocks/{id}/children
Summary: Retrieve block children
Retrieve block children
OpenAPI snippet URL
PATCH /v1/blocks/{id}/children
Summary: Append block children
Append block children
OpenAPI snippet URL
PARAMETERS /v1/blocks/{id}/children
OpenAPI snippet URL
GET /v1/blocks/{id}
Summary: Retrieve a block
Retrieve a block
OpenAPI snippet URL
DELETE /v1/blocks/{id}
Summary: Delete a block
Delete a block
OpenAPI snippet URL
PATCH /v1/blocks/{id}
Summary: Update a block
This endpoint allows you to update block content. See Full Documentation
OpenAPI snippet URL
PARAMETERS /v1/blocks/{id}
OpenAPI snippet URL
POST /v1/search
Summary: Search
Search
OpenAPI snippet URL
GET /v1/comments
Summary: Retrieve comments
Retrieve a user object using the ID specified in the request path.
OpenAPI snippet URL
POST /v1/comments
Summary: Add comment to page
Add comment to page
OpenAPI snippet URL