Notion

Handle Initialize Authorization

post

Handle integration initialization request.

Body
or
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/notion/integrations

No content

Handle User Has Integration

get

Handle user integration existence check.

Responses
chevron-right
200

Successful Response

application/json
Responseany
get
/connectors/notion/integration-exists
200

Successful Response

No content

Auth Schema

get

Handle authentication schema request.

Responses
chevron-right
200

Successful Response

application/json
Responseany
get
/connectors/notion/auth-schema
200

Successful Response

No content

Get Integration

get
Path parameters
user_identifierstringRequired
Responses
chevron-right
200

Successful Response

application/json
Responseany
get
/connectors/notion/integrations/{user_identifier}

No content

Select Integration

post
Path parameters
user_identifierstringRequired
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/notion/integrations/{user_identifier}

No content

Remove Integration

delete
Path parameters
user_identifierstringRequired
Responses
chevron-right
200

Successful Response

application/json
Responseany
delete
/connectors/notion/integrations/{user_identifier}

No content

Success Authorize Callback

get
Responses
chevron-right
200

Successful Response

application/json
Responseany
get
/connectors/notion/success-authorize-callback
200

Successful Response

No content

Get Page

post

Retrieves a Page object using the ID specified. Returns page properties (limited to 25 references per property) but not page content. For page content, use the Retrieve block children endpoint. For properties with >25 references, use the Retrieve a page property endpoint. If page's parent is a database, properties conform to database schema. If not, only title is available.

Body
response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
queryany ofOptional

query parameters

or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
post
/connectors/notion/get_page

Search Pages

post

Searches all pages that have been shared with an integration. Returns pages that have titles matching the query.

Body
response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
post
/connectors/notion/search_pages

Toggle Page Archive

post

Archives or restores a page. Note: Cannot archive workspace-level pages via API, and the API does not support permanently deleting pages.

Body
response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
post
/connectors/notion/toggle_page_archive

Restore Page

post

Restores a page from trash.

Body
response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
post
/connectors/notion/restore_page

List Users

post

Returns a paginated list of Users for the workspace. Does not include guests. Requires user information capabilities.

Body
response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
queryany ofOptional

Query parameters

or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
post
/connectors/notion/list_users

Get User

post

Retrieves a User using the ID specified. Requires user information capabilities.

Body
response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
post
/connectors/notion/get_user

Get Me

post

Retrieves the bot User associated with the API token provided in the authorization header.

Responses
chevron-right
200

Successful Response

application/json
post
/connectors/notion/get_me
200

Successful Response

Last updated

Was this helpful?