Appearance

Get Pages ​

Endpoint ​

http
GET /unified/knowledge-base/pages/{id}
Integrations supported
  • Canny
  • Coda
  • Confluence
  • Confluence On Prem
  • Discourse
  • Google Docs
  • Help Scout Docs
  • HubSpot
  • Intercom
  • Monday.com
  • Notion
  • Readme
  • SharePoint
  • Zendesk - Help Center

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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_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_type
string

The type of the page

All possible enum values:
  • articles
  • blog-posts
  • community-posts
  • database
  • landing-pages
  • page
  • site-pages
Enum support by integration
  • HubSpot
    • landing-pages
    • site-pages
    • blog-posts
  • Notion
    • database
    • page
  • Zendesk - Help Center
    • articles
    • community-posts
Required in
  • HubSpot
  • Zendesk - Help Center
Supported in
  • Notion
space
object

The space the page belongs to

Required in
  • SharePoint
id
string

The unique identifier for the space

collection
object

The collection to fetch the pages for

Required in
  • Coda
id
string

Unique identifier of the collection

Response Body ​

id
string
REQUIRED · 

The unique identifier for the page

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

The title of the page

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

The description of the page

Supported in
  • Canny
  • Coda
  • HubSpot
  • Intercom
  • Notion
  • Readme
  • SharePoint
  • Zendesk - Help Center
page_type
string

The type of the page

All possible enum values:
  • landing-pages
  • site-pages
  • blog-posts
  • page
  • database
Supported in
  • Canny
  • Coda
  • Discourse
  • Google Docs
  • Help Scout Docs
  • HubSpot
  • Intercom
  • Notion
  • Readme
  • SharePoint
  • Zendesk - Help Center
status
string

The status of the page

All possible enum values:
  • draft
  • published
  • archived
  • deleted
Supported in
  • Canny
  • Confluence
  • Confluence On Prem
  • Discourse
  • Google Docs
  • Help Scout Docs
  • HubSpot
  • Intercom
  • Notion
  • SharePoint
  • Zendesk - Help Center
tags
string[]

The tags associated with the page

Supported in
  • Canny
  • Discourse
  • Help Scout Docs
  • Notion
  • Zendesk - Help Center
parent
object

The parent of the page

Supported in
  • Coda
  • Confluence
  • Confluence On Prem
  • Intercom
  • Notion
id
string

The unique identifier for the parent page

type
string

The type of the parent

space
object

The space the page belongs to

Supported in
  • Canny
  • Confluence
  • Confluence On Prem
  • Monday.com
  • SharePoint
id
string

The unique identifier for the space

collection
object

The collection the page belongs to

Supported in
  • Help Scout Docs
id
string

The unique identifier for the collection

created_by
object

The user who created the page

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

The unique identifier for the user

name
string

The name of the user

emails
object[]

The emails of the user

email
string

The email of the user

is_primary
boolean

Whether the email is the primary email of the user

type
string

The type of the email

All possible enum values:
  • work
  • home
  • other
last_edited_by
object

The user who last edited the page

Supported in
  • Coda
  • Confluence
  • Confluence On Prem
  • Google Docs
  • Help Scout Docs
  • HubSpot
  • Notion
  • SharePoint
id
string

The unique identifier for the user

name
string

The name of the user

emails
object[]

The emails of the user

email
string

The email of the user

is_primary
boolean

Whether the email is the primary email of the user

type
string

The type of the email

All possible enum values:
  • work
  • home
  • other
published_at
string · date-time

The date and time the page was published

Supported in
  • Canny
  • Help Scout Docs
  • HubSpot
  • Notion
urls
object[]

The urls of the page

Supported in
  • Canny
  • Coda
  • Confluence
  • Confluence On Prem
  • Google Docs
  • Help Scout Docs
  • HubSpot
  • Intercom
  • Monday.com
  • Notion
  • Readme
  • SharePoint
  • Zendesk - Help Center
url
string

The url of the page

type
string

The type of the url

All possible enum values:
  • view
  • edit
  • public_view
created_at
string · date-time

The date and time the page was created

Supported in
  • Canny
  • Coda
  • Confluence
  • Confluence On Prem
  • Discourse
  • Google Docs
  • Help Scout Docs
  • HubSpot
  • Intercom
  • Monday.com
  • Notion
  • Readme
  • SharePoint
  • Zendesk - Help Center
updated_at
string · date-time

The date and time the page was last updated

Supported in
  • Coda
  • Confluence
  • Confluence On Prem
  • Discourse
  • Google Docs
  • Help Scout Docs
  • HubSpot
  • Intercom
  • Notion
  • Readme
  • SharePoint
  • 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.