Get content descendants

GET {{baseUrl}}/api/content/:id/descendant?expand=<string>&expand=<string>

Returns a map of the descendants of a piece of content. This is similar to Get content children, except that this method returns child pages at all levels, rather than just the direct child pages.

A piece of content has different types of descendants, depending on its type:

  • page: descendant is page, comment, attachment
  • blogpost: descendant is comment, attachment
  • attachment: descendant is comment
  • comment: descendant is attachment

The map will always include all descendant types that are valid for the content. However, if the content has no instances of a descendant type, the map will contain an empty array for that descendant type.

Permissions required: 'View' permission for the space, and permission to view the content if it is a page.

Request Params

KeyDatatypeRequiredDescription
expandstringA multi-value parameter indicating which properties of the children to
expand, where:
  • attachment returns all attachments for the content.

  • comments returns all comments for the content.

  • page returns all child pages of the content. | | expand | string | | A multi-value parameter indicating which properties of the children to expand, where:

  • attachment returns all attachments for the content.

  • comments returns all comments for the content.

  • page returns all child pages of the content. |

RESPONSES

status: OK

{&quot;_expandable&quot;:{&quot;attachment&quot;:&quot;in ut&quot;,&quot;comment&quot;:&quot;dolor&quot;,&quot;page&quot;:&quot;eu exercitation&quot;},&quot;_links&quot;:{},&quot;attachment&quot;:{&quot;results&quot;:[{&quot;value&quot;:&quot;\u003cCircular reference to #/components/schemas/Content detected\u003e&quot;},{&quot;value&quot;:&quot;\u003cCircular reference to #/components/schemas/Content detected\u003e&quot;}],&quot;start&quot;:-75729038,&quot;limit&quot;:34726306,&quot;size&quot;:18934279,&quot;_links&quot;:{}},&quot;comment&quot;:{&quot;results&quot;:[{&quot;value&quot;:&quot;\u003cCircular reference to #/components/schemas/Content detected\u003e&quot;},{&quot;value&quot;:&quot;\u003cCircular reference to #/components/schemas/Content detected\u003e&quot;}],&quot;start&quot;:37994470,&quot;limit&quot;:2587712,&quot;size&quot;:-24049554,&quot;_links&quot;:{}},&quot;page&quot;:{&quot;results&quot;:[{&quot;value&quot;:&quot;\u003cCircular reference to #/components/schemas/Content detected\u003e&quot;},{&quot;value&quot;:&quot;\u003cCircular reference to #/components/schemas/Content detected\u003e&quot;}],&quot;start&quot;:66843073,&quot;limit&quot;:57682154,&quot;size&quot;:-4004438,&quot;_links&quot;:{}}}