v1
latestOpenAPI 3.0.32026-07-13218142597.2 KBGet descendants of folder
Returns descendants in the content tree for a given folder by ID in top-to-bottom order (that is, the highest descendant is the first item in the response payload). The number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth of descendants to be fetched.
The following types of content will be returned:
- Database
- Embed
- Folder
- Page
- Whiteboard
This endpoint returns minimal information about each descendant. To fetch more details, use a related endpoint based on the content type, such as:
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the and its corresponding space
Path parameters
The ID of the folder.
Query parameters
Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results.
Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants.
Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
Response
Returned if the requested descendants are returned.