Appearance

List Page content ​

Endpoint ​

http
GET /unified/knowledge-base/page-content
Integrations supported
  • Canny
  • Confluence
  • Confluence On Prem
  • Discourse
  • Help Scout Docs
  • HubSpot
  • Intercom
  • Monday.com
  • Notion
  • Readme
  • SharePoint
  • Webflow
  • Zendesk - Help Center

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
page
object

The page the content belongs to

Required in
  • Canny
  • Confluence
  • Confluence On Prem
  • Help Scout Docs
  • Intercom
  • Monday.com
  • Notion
  • Readme
  • SharePoint
  • Webflow
  • Zendesk - Help Center
id
string
REQUIRED · 

The unique identifier for the page

page_type
string

The type of the page

All possible enum values:
  • articles
  • blog-posts
  • community-posts
  • landing-pages
  • site-pages
Enum support by integration
  • HubSpot
    • landing-pages
    • site-pages
    • blog-posts
  • Zendesk - Help Center
    • articles
    • community-posts
Required in
  • HubSpot
  • Zendesk - Help Center
created_at
string · date-time

The date and time the page content was created

Supported in
  • HubSpot
updated_at
string · date-time

The date and time the page content was last updated

Supported in
  • HubSpot
format
string

The type of the format to retrieve the content.

All possible enum values:
  • html
  • markdown
Supported in
  • Confluence
  • Confluence On Prem
  • Help Scout Docs
  • SharePoint
  • Zendesk - Help Center
page_id
Supported in
  • Notion
page_content_id
string

The unique identifier for the page content

Supported in
  • Notion
space
object
Required in
  • SharePoint
id
string

The unique identifier for the space

Response Body ​

result
object[]

List of Page content

id
string
REQUIRED · 

The unique identifier for the page content

Supported in
  • Canny
  • Confluence
  • Confluence On Prem
  • Discourse
  • Help Scout Docs
  • HubSpot
  • Intercom
  • Monday.com
  • Notion
  • Readme
  • SharePoint
  • Webflow
  • Zendesk - Help Center
sequence
integer

The order of the page content in the context of a page. Will increase sequentially from 0.

Supported in
  • Confluence
  • Confluence On Prem
  • Help Scout Docs
  • Notion
  • Readme
page
object

The page the content belongs to

Supported in
  • Canny
  • Confluence
  • Confluence On Prem
  • Discourse
  • Help Scout Docs
  • Intercom
  • Monday.com
  • Notion
  • Readme
  • SharePoint
  • Zendesk - Help Center
id
string

The unique identifier for the page

page_type
string

The type of the page

All possible enum values:
  • landing-pages
  • site-pages
  • blog-posts
Supported in
  • Canny
  • Discourse
  • Help Scout Docs
  • HubSpot
  • Intercom
  • Readme
  • Zendesk - Help Center
parent
object

The parent of the page content

Supported in
  • Monday.com
  • Notion
id
string

The unique identifier for the parent page content

type
string

The type of the parent

has_children
boolean

Whether the page content has children

Supported in
  • Help Scout Docs
  • HubSpot
  • Notion
  • SharePoint
body
object

The body of the page content

Supported in
  • Canny
  • Confluence
  • Confluence On Prem
  • Discourse
  • Help Scout Docs
  • HubSpot
  • Intercom
  • Monday.com
  • Notion
  • Readme
  • SharePoint
  • Webflow
  • Zendesk - Help Center
format
string

The format of the body

All possible enum values:
  • markdown
  • html
  • plaintext
content
string

The content of the body

urls
object[]

The URLs of the files attached in the page content

Supported in
  • Confluence
  • Confluence On Prem
  • Help Scout Docs
  • Notion
  • Readme
  • SharePoint
  • Zendesk - Help Center
url
string

The URL of the file

type
string

The URL type of the file

All possible enum values:
  • original_url
  • truto_download
created_at
string · date-time

The date and time the page content was created

Supported in
  • Canny
  • Discourse
  • Help Scout Docs
  • HubSpot
  • Intercom
  • Monday.com
  • Notion
  • Readme
  • Zendesk - Help Center
updated_at
string · date-time

The date and time the page content was last updated

Supported in
  • Discourse
  • Help Scout Docs
  • HubSpot
  • Intercom
  • Monday.com
  • Notion
  • Readme
  • Zendesk - Help Center
visibility
string

The visibility of the page

All possible enum values:
  • private
  • public
Supported in
  • Readme
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.