Cloud
Confluence Cloud / Reference / REST API

Content - children and descendants

Postman Collection
Operations
GET/wiki/rest/api/content/{id}/childPUT/wiki/rest/api/content/{pageId}/move/{position}/{targetId}GET/wiki/rest/api/content/{id}/child/{type}GET/wiki/rest/api/content/{id}/descendantGET/wiki/rest/api/content/{id}/descendant/{type}POST/wiki/rest/api/content/{id}/pagehierarchy/copyPOST/wiki/rest/api/content/{id}/copy
GET

Get content childrenDeprecated

Deprecated, use Confluence's v2 API.

Returns a map of the direct children of a piece of content. A piece of content has different types of child content, depending on its type. These are the default parent-child content type relationships:

  • page: child content is page, whiteboard, database, embed, folder, comment, attachment
  • whiteboard: child content is page, whiteboard, database, embed, folder, comment, attachment
  • database: child content is page, whiteboard, database, embed, folder, comment, attachment
  • embed: child content is page, whiteboard, database, embed, folder, comment, attachment
  • folder: child content is page, whiteboard, database, embed, folder, comment, attachment
  • blogpost: child content is comment, attachment
  • attachment: child content is comment
  • comment: child content is attachment

Apps can override these default relationships. Apps can also introduce new content types that create new parent-child content relationships.

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

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

Data Security Policy: Not exempt from app access rules
Scopes
OAuth 2.0 scopes required:
ClassicRECOMMENDED:read:confluence-content.summary
Granular:read:content-details:confluence

Connect app scope required: READ

Request

Path parameters

id

string

Required

Query parameters

expand

array<string>

parentVersion

integer

Responses

Returned if the requested content children are returned.

application/json

ContentChildren
GET/wiki/rest/api/content/{id}/child
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestConfluence(route`/wiki/rest/api/content/{id}/child`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 { "attachment": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "comment": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "page": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "whiteboard": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "database": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "embed": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "folder": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "_expandable": { "attachment": "<string>", "comment": "<string>", "page": "<string>", "whiteboard": "<string>", "database": "<string>", "embed": "<string>", "folder": "<string>" }, "_links": {} }
PUT

Move a page to a new location relative to a target page

Move a page to a new location relative to a target page:

  • before - move the page under the same parent as the target, before the target in the list of children
  • after - move the page under the same parent as the target, after the target in the list of children
  • append - move the page to be a child of the target

Caution: This API can move pages to the top level of a space. Top-level pages are difficult to find in the UI because they do not show up in the page tree display. To avoid this, never use before or after positions when the targetId is a top-level page.

Data Security Policy: Not exempt from app access rules
Scopes
OAuth 2.0 scopes required:
ClassicRECOMMENDED:write:confluence-content
Granular:write:page:confluence

Connect app scope required: WRITE

Request

Path parameters

pageId

string

Required
position

string

Required
targetId

string

Required

Responses

Page was successfully moved

application/json

object
PUT/wiki/rest/api/content/{pageId}/move/{position}/{targetId}
1 2 3 4 5 6 7 8 9 10 11 12 13 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestConfluence(route`/wiki/rest/api/content/{pageId}/move/{position}/{targetId}`, { method: 'PUT', headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 { "pageId": "<string>" }
GET

Get content children by typeDeprecated

Deprecated, use Confluence's v2 API.

Returns all children of a given type, for a piece of content. A piece of content has different types of child content, depending on its type:

  • page: child content is page, whiteboard, database, embed, folder, comment, attachment
  • whiteboard: child content is page, whiteboard, database, embed, folder, comment, attachment
  • database: child content is page, whiteboard, database, embed, folder, comment, attachment
  • embed: child content is page, whiteboard, database, embed, folder, comment, attachment
  • folder: child content is page, whiteboard, database, embed, folder, comment, attachment
  • blogpost: child content is comment, attachment
  • attachment: child content is comment
  • comment: child content is attachment

Custom content types that are provided by apps can also be returned.

Note, this method only returns direct children. To return children at all levels, use Get descendants by type.

If the expand query parameter is used with the body.export_view and/or body.styled_view properties, then the query limit parameter will be restricted to a maximum value of 25.

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

Data Security Policy: Not exempt from app access rules
Scopes
OAuth 2.0 scopes required:
ClassicRECOMMENDED:read:confluence-content.summary
Granular:read:content-details:confluence

Connect app scope required: READ

Request

Path parameters

id

string

Required
type

string

Required

Query parameters

expand

array<string>

parentVersion

integer

start

integer

limit

integer

Responses

Returned if the requested content is returned.

application/json

ContentArray
GET/wiki/rest/api/content/{id}/child/{type}
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestConfluence(route`/wiki/rest/api/content/{id}/child/{type}`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "id": 2154, "key": "<string>", "alias": "<string>", "name": "<string>", "icon": { "path": "<string>", "width": 2154, "height": 2154, "isDefault": true }, "description": { "plain": { "value": "<string>", "representation": "plain", "embeddedContent": [ {} ] }, "view": { "value": "<string>", "representation": "plain", "embeddedContent": [ {} ] }, "_expandable": { "view": "<string>", "plain": "<string>" } }, "type": "<string>", "metadata": { "labels": { "results": [ { "prefix": "<string>", "name": "<string>", "id": "<string>", "label": "<string>" } ], "size": 2154 }, "_expandable": {} }, "operations": [ { "operation": "administer", "targetType": "<string>" } ], "permissions": [ { "operation": { "operation": "administer", "targetType": "<string>" }, "anonymousAccess": true, "unlicensedAccess": true } ], "status": "<string>", "settings": { "routeOverrideEnabled": true, "_links": {} }, "theme": { "themeKey": "<string>" }, "lookAndFeel": { "headings": { "color": "<string>" }, "links": { "color": "<string>" }, "menus": { "hoverOrFocus": { "backgroundColor": "<string>" }, "color": "<string>" }, "header": { "backgroundColor": "<string>", "button": { "backgroundColor": "<string>", "color": "<string>" }, "primaryNavigation": { "color": "<string>", "hoverOrFocus": { "backgroundColor": "<string>", "color": "<string>" } }, "secondaryNavigation": { "color": "<string>", "hoverOrFocus": { "backgroundColor": "<string>", "color": "<string>" } }, "search": { "backgroundColor": "<string>", "color": "<string>" } }, "content": {}, "bordersAndDividers": { "color": "<string>" } }, "history": { "createdDate": "<string>", "createdBy": { "type": "known" } }, "_expandable": { "settings": "<string>", "metadata": "<string>", "operations": "<string>", "lookAndFeel": "<string>", "permissions": "<string>", "icon": "<string>", "description": "<string>", "theme": "<string>", "history": "<string>", "homepage": "<string>", "identifiers": "<string>" }, "_links": {} }, "history": { "latest": true, "createdBy": { "type": "known" }, "ownedBy": { "type": "known" }, "lastOwnedBy": { "type": "known" }, "createdDate": "<string>", "lastUpdated": { "when": "<string>", "number": 57, "minorEdit": true }, "previousVersion": { "when": "<string>", "number": 57, "minorEdit": true }, "contributors": { "publishers": {} }, "nextVersion": { "when": "<string>", "number": 57, "minorEdit": true }, "_expandable": { "lastUpdated": "<string>", "previousVersion": "<string>", "contributors": "<string>", "nextVersion": "<string>", "ownedBy": "<string>", "lastOwnedBy": "<string>" }, "_links": {} }, "version": { "by": { "type": "known" }, "when": "<string>", "friendlyWhen": "<string>", "message": "<string>", "number": 57, "minorEdit": true, "collaborators": {}, "_expandable": { "content": "<string>", "collaborators": "<string>" }, "_links": {}, "contentTypeModified": true, "confRev": "<string>", "syncRev": "<string>", "syncRevSource": "<string>" }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "children": { "_expandable": { "attachment": "<string>", "comment": "<string>", "page": "<string>", "whiteboard": "<string>", "database": "<string>", "embed": "<string>", "folder": "<string>" }, "_links": {} }, "childTypes": { "attachment": { "value": true, "_links": {} }, "comment": { "value": true, "_links": {} }, "page": { "value": true, "_links": {} }, "_expandable": { "all": "<string>", "attachment": "<string>", "comment": "<string>", "page": "<string>", "whiteboard": "<string>", "database": "<string>", "embed": "<string>", "folder": "<string>" } }, "descendants": { "_expandable": { "attachment": "<string>", "comment": "<string>", "page": "<string>", "whiteboard": "<string>", "database": "<string>", "embed": "<string>", "folder": "<string>" }, "_links": {} }, "container": {}, "body": { "view": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "export_view": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "styled_view": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "storage": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "wiki": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "editor": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "editor2": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "anonymous_export_view": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "atlas_doc_format": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "dynamic": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "raw": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "restrictions": { "user": { "results": [ { "type": "known" } ] }, "group": { "results": [ { "type": "group", "name": "<string>", "id": "<string>" } ], "start": 2154, "limit": 2154, "size": 2154 }, "_expandable": { "user": "<string>", "group": "<string>" } }, "_expandable": { "restrictions": "<string>", "content": "<string>" }, "_links": {} }, "update": { "operation": "administer", "restrictions": { "user": { "results": [ { "type": "known" } ] }, "group": { "results": [ { "type": "group", "name": "<string>", "id": "<string>" } ], "start": 2154, "limit": 2154, "size": 2154 }, "_expandable": { "user": "<string>", "group": "<string>" } }, "_expandable": { "restrictions": "<string>", "content": "<string>" }, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": { "currentuser": { "favourited": { "isFavourite": true, "favouritedDate": "<string>" }, "lastmodified": { "version": { "when": "<string>", "number": 57, "minorEdit": true }, "friendlyLastModified": "<string>" }, "lastcontributed": { "status": "<string>", "when": "<string>" }, "viewed": { "lastSeen": "<string>", "friendlyLastSeen": "<string>" }, "scheduled": {}, "_expandable": { "favourited": "<string>", "lastmodified": "<string>", "lastcontributed": "<string>", "viewed": "<string>", "scheduled": "<string>" } }, "properties": {}, "frontend": {}, "labels": { "results": [ { "prefix": "<string>", "name": "<string>", "id": "<string>", "label": "<string>" } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} } }, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }
GET

Get content descendants

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, whiteboard, database, embed, folder, comment, attachment
  • whiteboard: descendant is page, whiteboard, database, embed, folder, comment, attachment
  • database: descendant is page, whiteboard, database, embed, folder, comment, attachment
  • embed: descendant is page, whiteboard, database, embed, folder, comment, attachment
  • folder: descendant is page, whiteboard, database, embed, folder, 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.

Data Security Policy: Not exempt from app access rules
Scopes
OAuth 2.0 scopes required:
ClassicRECOMMENDED:read:confluence-content.summary
Granular:read:content-details:confluence

Connect app scope required: READ

Request

Path parameters

id

string

Required

Query parameters

expand

array<string>

Responses

Returned if the requested descendants are returned.

application/json

ContentChildren
GET/wiki/rest/api/content/{id}/descendant
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestConfluence(route`/wiki/rest/api/content/{id}/descendant`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 { "attachment": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "comment": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "page": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "whiteboard": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "database": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "embed": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "folder": { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "key": "<string>", "name": "<string>", "type": "<string>", "status": "<string>", "_expandable": {}, "_links": {} }, "history": { "latest": true }, "version": { "when": "<string>", "number": 57, "minorEdit": true }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "childTypes": {}, "container": {}, "body": { "view": { "value": "<string>", "representation": "view" }, "export_view": { "value": "<string>", "representation": "view" }, "styled_view": { "value": "<string>", "representation": "view" }, "storage": { "value": "<string>", "representation": "view" }, "wiki": { "value": "<string>", "representation": "view" }, "editor": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" }, "anonymous_export_view": { "value": "<string>", "representation": "view" }, "atlas_doc_format": { "value": "<string>", "representation": "view" }, "dynamic": { "value": "<string>", "representation": "view" }, "raw": { "value": "<string>", "representation": "view" }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "_expandable": {}, "_links": {} }, "update": { "operation": "administer", "_expandable": {}, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": {}, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }, "_expandable": { "attachment": "<string>", "comment": "<string>", "page": "<string>", "whiteboard": "<string>", "database": "<string>", "embed": "<string>", "folder": "<string>" }, "_links": {} }
GET

Get content descendants by type

Returns all descendants of a given type, for a piece of content. This is similar to Get content children by type, 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, whiteboard, database, embed, folder, comment, attachment
  • whiteboard: descendant is page, whiteboard, database, embed, folder, comment, attachment
  • database: descendant is page, whiteboard, database, embed, folder, comment, attachment
  • embed: descendant is page, whiteboard, database, embed, folder, comment, attachment
  • folder: descendant is page, whiteboard, database, embed, folder, comment, attachment
  • blogpost: descendant is comment, attachment
  • attachment: descendant is comment
  • comment: descendant is attachment

Custom content types that are provided by apps can also be returned.

If the expand query parameter is used with the body.export_view and/or body.styled_view properties, then the query limit parameter will be restricted to a maximum value of 25.

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

Data Security Policy: Not exempt from app access rules
Scopes
OAuth 2.0 scopes required:
ClassicRECOMMENDED:read:confluence-content.summary
Granular:read:content-details:confluence

Connect app scope required: READ

Request

Path parameters

id

string

Required
type

string

Required

Query parameters

depth

string

expand

array<string>

start

integer

limit

integer

Responses

Returned if the requested content is returned.

application/json

ContentArray
GET/wiki/rest/api/content/{id}/descendant/{type}
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestConfluence(route`/wiki/rest/api/content/{id}/descendant/{type}`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 { "results": [ { "id": "<string>", "type": "<string>", "status": "<string>", "title": "<string>", "space": { "id": 2154, "key": "<string>", "alias": "<string>", "name": "<string>", "icon": { "path": "<string>", "width": 2154, "height": 2154, "isDefault": true }, "description": { "plain": { "value": "<string>", "representation": "plain", "embeddedContent": [ {} ] }, "view": { "value": "<string>", "representation": "plain", "embeddedContent": [ {} ] }, "_expandable": { "view": "<string>", "plain": "<string>" } }, "type": "<string>", "metadata": { "labels": { "results": [ { "prefix": "<string>", "name": "<string>", "id": "<string>", "label": "<string>" } ], "size": 2154 }, "_expandable": {} }, "operations": [ { "operation": "administer", "targetType": "<string>" } ], "permissions": [ { "operation": { "operation": "administer", "targetType": "<string>" }, "anonymousAccess": true, "unlicensedAccess": true } ], "status": "<string>", "settings": { "routeOverrideEnabled": true, "_links": {} }, "theme": { "themeKey": "<string>" }, "lookAndFeel": { "headings": { "color": "<string>" }, "links": { "color": "<string>" }, "menus": { "hoverOrFocus": { "backgroundColor": "<string>" }, "color": "<string>" }, "header": { "backgroundColor": "<string>", "button": { "backgroundColor": "<string>", "color": "<string>" }, "primaryNavigation": { "color": "<string>", "hoverOrFocus": { "backgroundColor": "<string>", "color": "<string>" } }, "secondaryNavigation": { "color": "<string>", "hoverOrFocus": { "backgroundColor": "<string>", "color": "<string>" } }, "search": { "backgroundColor": "<string>", "color": "<string>" } }, "content": {}, "bordersAndDividers": { "color": "<string>" } }, "history": { "createdDate": "<string>", "createdBy": { "type": "known" } }, "_expandable": { "settings": "<string>", "metadata": "<string>", "operations": "<string>", "lookAndFeel": "<string>", "permissions": "<string>", "icon": "<string>", "description": "<string>", "theme": "<string>", "history": "<string>", "homepage": "<string>", "identifiers": "<string>" }, "_links": {} }, "history": { "latest": true, "createdBy": { "type": "known" }, "ownedBy": { "type": "known" }, "lastOwnedBy": { "type": "known" }, "createdDate": "<string>", "lastUpdated": { "when": "<string>", "number": 57, "minorEdit": true }, "previousVersion": { "when": "<string>", "number": 57, "minorEdit": true }, "contributors": { "publishers": {} }, "nextVersion": { "when": "<string>", "number": 57, "minorEdit": true }, "_expandable": { "lastUpdated": "<string>", "previousVersion": "<string>", "contributors": "<string>", "nextVersion": "<string>", "ownedBy": "<string>", "lastOwnedBy": "<string>" }, "_links": {} }, "version": { "by": { "type": "known" }, "when": "<string>", "friendlyWhen": "<string>", "message": "<string>", "number": 57, "minorEdit": true, "collaborators": {}, "_expandable": { "content": "<string>", "collaborators": "<string>" }, "_links": {}, "contentTypeModified": true, "confRev": "<string>", "syncRev": "<string>", "syncRevSource": "<string>" }, "ancestors": [], "operations": [ { "operation": "administer", "targetType": "<string>" } ], "children": { "_expandable": { "attachment": "<string>", "comment": "<string>", "page": "<string>", "whiteboard": "<string>", "database": "<string>", "embed": "<string>", "folder": "<string>" }, "_links": {} }, "childTypes": { "attachment": { "value": true, "_links": {} }, "comment": { "value": true, "_links": {} }, "page": { "value": true, "_links": {} }, "_expandable": { "all": "<string>", "attachment": "<string>", "comment": "<string>", "page": "<string>", "whiteboard": "<string>", "database": "<string>", "embed": "<string>", "folder": "<string>" } }, "descendants": { "_expandable": { "attachment": "<string>", "comment": "<string>", "page": "<string>", "whiteboard": "<string>", "database": "<string>", "embed": "<string>", "folder": "<string>" }, "_links": {} }, "container": {}, "body": { "view": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "export_view": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "styled_view": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "storage": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "wiki": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "editor": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "editor2": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "anonymous_export_view": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "atlas_doc_format": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "dynamic": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "raw": { "value": "<string>", "representation": "view", "embeddedContent": [ {} ], "webresource": {}, "mediaToken": { "collectionIds": [ "<string>" ], "contentId": "<string>", "expiryDateTime": "<string>", "fileIds": [ "<string>" ], "token": "<string>" }, "_expandable": { "content": "<string>", "embeddedContent": "<string>", "webresource": "<string>", "mediaToken": "<string>" }, "_links": {} }, "_expandable": { "editor": "<string>", "view": "<string>", "export_view": "<string>", "styled_view": "<string>", "storage": "<string>", "editor2": "<string>", "anonymous_export_view": "<string>", "atlas_doc_format": "<string>", "wiki": "<string>", "dynamic": "<string>", "raw": "<string>" } }, "restrictions": { "read": { "operation": "administer", "restrictions": { "user": { "results": [ { "type": "known" } ] }, "group": { "results": [ { "type": "group", "name": "<string>", "id": "<string>" } ], "start": 2154, "limit": 2154, "size": 2154 }, "_expandable": { "user": "<string>", "group": "<string>" } }, "_expandable": { "restrictions": "<string>", "content": "<string>" }, "_links": {} }, "update": { "operation": "administer", "restrictions": { "user": { "results": [ { "type": "known" } ] }, "group": { "results": [ { "type": "group", "name": "<string>", "id": "<string>" } ], "start": 2154, "limit": 2154, "size": 2154 }, "_expandable": { "user": "<string>", "group": "<string>" } }, "_expandable": { "restrictions": "<string>", "content": "<string>" }, "_links": {} }, "_expandable": { "read": "<string>", "update": "<string>" }, "_links": {} }, "metadata": { "currentuser": { "favourited": { "isFavourite": true, "favouritedDate": "<string>" }, "lastmodified": { "version": { "when": "<string>", "number": 57, "minorEdit": true }, "friendlyLastModified": "<string>" }, "lastcontributed": { "status": "<string>", "when": "<string>" }, "viewed": { "lastSeen": "<string>", "friendlyLastSeen": "<string>" }, "scheduled": {}, "_expandable": { "favourited": "<string>", "lastmodified": "<string>", "lastcontributed": "<string>", "viewed": "<string>", "scheduled": "<string>" } }, "properties": {}, "frontend": {}, "labels": { "results": [ { "prefix": "<string>", "name": "<string>", "id": "<string>", "label": "<string>" } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} } }, "macroRenderedOutput": {}, "extensions": {}, "_expandable": { "childTypes": "<string>", "container": "<string>", "metadata": "<string>", "operations": "<string>", "children": "<string>", "restrictions": "<string>", "history": "<string>", "ancestors": "<string>", "body": "<string>", "version": "<string>", "descendants": "<string>", "space": "<string>", "extensions": "<string>", "schedulePublishDate": "<string>", "schedulePublishInfo": "<string>", "macroRenderedOutput": "<string>" }, "_links": {} } ], "start": 2154, "limit": 2154, "size": 2154, "_links": {} }
POST

Copy page hierarchy

Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments. The id path parameter refers to the content id of the page to copy, and the new parent of this copied page is defined using the destinationPageId in the request body. The titleOptions object defines the rules of renaming page titles during the copy; for example, search and replace can be used in conjunction to rewrite the copied page titles.

Response example:

1
2
3
4
5
6
7
8

 {
      "id" : "1180606",
      "links" : {
           "status" : "/rest/api/longtask/1180606"
      }
 }

Use the /longtask/ REST API to get the copy task status.

Data Security Policy: Not exempt from app access rules
Scopes
OAuth 2.0 scopes required:
ClassicRECOMMENDED:write:confluence-content
Granular:read:content.metadata:confluence, write:page:confluence

Connect app scope required: WRITE

Request

Path parameters

id

string

Required

Request bodyapplication/json

Request object from json post body

copyAttachments

boolean

copyPermissions

boolean

copyProperties

boolean

copyLabels

boolean

copyCustomContents

boolean

copyDescendants

boolean

destinationPageId

ContentId

Required
titleOptions

CopyPageHierarchyTitleOptions

Responses

Returns a full JSON representation of a long running task

application/json

LongTask
POST/wiki/rest/api/content/{id}/pagehierarchy/copy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "copyAttachments": true, "copyPermissions": true, "copyProperties": true, "copyLabels": true, "copyCustomContents": true, "copyDescendants": true, "destinationPageId": "<string>", "titleOptions": { "prefix": "<string>", "replace": "<string>", "search": "<string>" } }`; const response = await api.asUser().requestConfluence(route`/wiki/rest/api/content/{id}/pagehierarchy/copy`, { method: 'POST', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
202Response
1 2 3 4 5 6 7 { "ari": "<string>", "id": "<string>", "links": { "status": "<string>" } }
POST

Copy single page

Copies a single page and its associated properties, permissions, attachments, and custom contents. The id path parameter refers to the content ID of the page to copy. The target of the page to be copied is defined using the destination in the request body and can be one of the following types.

  • space: page will be copied to the specified space as a root page on the space
  • parent_page: page will be copied as a child of the specified parent page
  • existing_page: page will be copied and replace the specified page

By default, the following objects are expanded: space, history, version.

Permissions required: 'Add' permission for the space that the content will be copied in and permission to update the content if copying to an existing_page.

Data Security Policy: Not exempt from app access rules
Scopes
OAuth 2.0 scopes required:
ClassicRECOMMENDED:write:confluence-content
Granular:read:content-details:confluence, write:page:confluence

Connect app scope required: WRITE

Request

Path parameters

id

string

Required

Query parameters

expand

array<string>

Request bodyapplication/json

Request object from json post body

copyAttachments

boolean

copyPermissions

boolean

copyProperties

boolean

copyLabels

boolean

copyCustomContents

boolean

destination

CopyPageRequestDestination

Required
pageTitle

string

body

object

Responses

Returned if the content is copied.

application/json;charset=UTF-8

Content

Base object for all content types.

Nullable: true
POST/wiki/rest/api/content/{id}/copy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "copyAttachments": true, "copyPermissions": true, "copyProperties": true, "copyLabels": true, "copyCustomContents": true, "destination": { "type": "space", "value": "<string>" }, "pageTitle": "<string>", "body": { "storage": { "value": "<string>", "representation": "view" }, "editor2": { "value": "<string>", "representation": "view" } } }`; const response = await api.asUser().requestConfluence(route`/wiki/rest/api/content/{id}/copy`, { method: 'POST', headers: { 'Accept': 'application/json;charset=UTF-8', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());

Rate this page: