Skip to main content
A set of endpoints used to retrieve Box Hub Document elements (pages and content blocks).

​
Box Hub Callout Box Text Block

A callout box block in the Box Hub Document.
PropertyTypeRequiredDescription
idstringYesThe unique identifier for this block.
parent_idstringNoThe unique identifier of the parent block. Null for direct children of the page. Can be null.
typeenum<string>YesThe type of this block. The value is always callout_box. Available options: callout_box.
fragmentstringYesText content of the block. Includes rich text formatting.
Example
{
  "id": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd",
  "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "type": "callout_box",
  "fragment": "This is the callout box"
}

​
Box Hub Divider Block

A divider block in the Box Hub Document.
PropertyTypeRequiredDescription
idstringYesThe unique identifier for this block.
parent_idstringNoThe unique identifier of the parent block. Null for direct children of the page. Can be null.
typeenum<string>YesThe type of this block. The value is always divider. Available options: divider.
Example
{
  "id": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd",
  "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "type": "divider"
}

​
Box Hub Document Blocks

A list of Hub Document blocks.
PropertyTypeRequiredDescription
entriesarray of Box Hub Document Block EntryYesOrdered list of blocks.
typeenum<string>YesThe value will always be document_blocks. Available options: document_blocks.
limitintegerNoThe limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
next_markerstringNoThe marker for the start of the next page of results. Can be null.
Example
{
  "entries": [
    {
      "id": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd",
      "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
      "type": "paragraph",
      "fragment": "This is the paragraph"
    }
  ],
  "type": "document_blocks",
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}

​
Box Hub Document Page

A Page in the Box Hub Document.
PropertyTypeRequiredDescription
idstringYesThe unique identifier for this page.
typestringYesThe type of this resource. The value is always page.
parent_idstringNoThe unique identifier of the parent page. Null for root-level pages. Can be null.
title_fragmentstringYesThe title text of the page. Includes rich text formatting.
Example
{
  "id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "type": "page",
  "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "title_fragment": "This is the home page title"
}

​
Box Hub Document Pages

A list of Hub Document Pages.
PropertyTypeRequiredDescription
entriesarray of Box Hub Document PageYesOrdered list of pages.
typeenum<string>YesThe value will always be document_pages. Available options: document_pages.
limitintegerNoThe limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
next_markerstringNoThe marker for the start of the next page of results. Can be null.
Example
{
  "entries": [
    {
      "id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
      "type": "page",
      "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
      "title_fragment": "This is the home page title"
    }
  ],
  "type": "document_pages",
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}

​
Box Hub Item List Block

An item list block in the Box Hub Document.
PropertyTypeRequiredDescription
idstringYesThe unique identifier for this block.
parent_idstringNoThe unique identifier of the parent block. Null for direct children of the page. Can be null.
typeenum<string>YesThe type of this block. The value is always item_list. Available options: item_list.
Example
{
  "id": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd",
  "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "type": "item_list"
}

​
Box Hub Paragraph Text Block

A paragraph block in the Box Hub Document.
PropertyTypeRequiredDescription
idstringYesThe unique identifier for this block.
parent_idstringNoThe unique identifier of the parent block. Null for direct children of the page. Can be null.
typeenum<string>YesThe type of this block. The value is always paragraph. Available options: paragraph.
fragmentstringYesText content of the block. Includes rich text formatting.
Example
{
  "id": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd",
  "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "type": "paragraph",
  "fragment": "This is the paragraph"
}

​
Box Hub Section Title Text Block

A section title block in the Box Hub Document.
PropertyTypeRequiredDescription
idstringYesThe unique identifier for this block.
parent_idstringNoThe unique identifier of the parent block. Null for direct children of the page. Can be null.
typeenum<string>YesThe type of this block. The value is always section_title. Available options: section_title.
fragmentstringYesText content of the block. Includes rich text formatting.
Example
{
  "id": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd",
  "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f",
  "type": "section_title",
  "fragment": "This is the section title"
}
Last modified on July 9, 2026