Get Blog Post Classification Level
-
Retrieves The Classification Level Assigned To A Specific Blog Post.
Get Blog Post Labels
-
Retrieves All Labels Associated With A Specific Blog Post.
Get Blog Posts
-
Returns All Blog Posts With Pagination Support Via Cursor Parameter.
Get Blog Posts For Label
-
Returns All Blog Posts Associated With A Specific Label.
Get Blog Posts In Space
-
Returns All Blog Posts In A Specific Space.
Get Blueprint Templates
-
Returns All Templates Provided By Blueprints. Use This Method To Retrieve All Global Blueprint Templates Or All Blueprint Templates In A Space. Note, All Global Blueprints Are Inherited By Each Space. Space Blueprints Can Be Customised Without Affecting The Global Blueprints.
Get Child Custom Content
-
Returns All Child Custom Content For A Given Custom Content By ID. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available Through The Next URL Present In The Link Response Header.
Get Children Footer Comments
-
Retrieves Child Replies To A Specific Footer Comment With Pagination Support.
Get Children Inline Comments
-
Retrieves Child Replies To A Specific Inline Comment With Pagination Support.
Get Content In Space With Given Content State
-
Returns All Content That Has The Provided Content State In A Space. 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. 'View' Permission For The Space Is Required.
Get Content Labels
-
Get Labels For A Specific Content Item From Confluence.
Get Content Properties For Attachment
-
Retrieves All Content Properties Tied To A Specified Attachment.
Get Content Properties For Blog Post
-
Retrieves All Content Properties Tied To A Specified Blog Post.
Get Content Properties For Comment
-
Retrieves Content Properties Attached To A Specified Comment.
Get Content Properties For Custom Content
-
Retrieves Content Properties Tied To A Specified Custom Content.
Get Content Properties For Database
-
Retrieves Content Properties Tied To A Specified Database.
Get Content Properties For Folder
-
Retrieves Content Properties Tied To A Specified Folder.
Get Content Properties For Page
-
Retrieves Content Properties Tied To A Specified Page.
Get Content Properties For Smart Link In The Content Tree
-
Retrieves Content Properties Tied To A Specified Smart Link In The Content Tree.
Get Content Properties For Whiteboard
-
Retrieves Content Properties Tied To A Specified Whiteboard.
Get Content Property For Attachment By Id
-
Retrieves A Specific Content Property By ID That Is Attached To A Specified Attachment.
Get Content Property For Blog Post By Id
-
Retrieves A Specific Content Property By ID That Is Attached To A Specified Blog Post.
Get Content Property For Comment By Id
-
Retrieves A Specific Content Property By ID That Is Attached To A Specified Comment.
Get Content Property For Custom Content By Id
-
Retrieves A Specific Content Property By ID That Is Attached To A Specified Custom Content.
Get Content Property For Database By Id
-
Retrieves A Specific Content Property By ID That Is Attached To A Specified Database.
Get Content Property For Folder By Id
-
Retrieves A Specific Content Property By ID That Is Attached To A Specified Folder.
Get Content Property For Page By Id
-
Retrieves A Specific Content Property By ID That Is Attached To A Specified Page.
Get Content Property For Smart Link In The Content Tree By Id
-
Retrieves A Specific Content Property By ID That Is Attached To A Specified Smart Link In The Content Tree.
Get Content Property For Whiteboard By Id
-
Retrieves A Specific Content Property By ID That Is Attached To A Specified Whiteboard.
Get Content Restriction Status For Group
-
Returns Whether The Specified Content Restriction Applies To A Group. For Example, If A Page With Id=123 Has A Read Restriction For The 123456 Group Id, The Following Request Will Return True - /Wiki/Rest/Api/Content/123/Restriction/ByOperation/Read/ByGroupId/123456. Note That A Response Of True Does Not Guarantee That The Group Can View The Page, As It Does Not Account For Account-Inherited Restrictions, Space Permissions, Or Even Product Access. Permission To View The Content Is Required.
Get Content Restriction Status For User
-
Returns Whether The Specified Content Restriction Applies To A User. For Example, If A Page With Id=123 Has A Read Restriction For A User With An Account ID Of 384093:32b4d9w0-F6a5-3535-11a3-9c8c88d10192, The Following Request Will Return True - /Wiki/Rest/Api/Content/123/Restriction/ByOperation/Read/User?AccountId=384093:32b4d9w0-F6a5-3535-11a3-9c8c88d10192. Note That A Response Of True Does Not Guarantee That The User Can View The Page, As It Does Not Account For Account-Inherited Restrictions, Space Permissions, Or Even Product Access. Permission To View The Content Is Required.
Get Content Restrictions
-
Returns The Restrictions On A Piece Of Content. Permission To View The Content Is Required.
Get Content Restrictions By Operation
-
Returns Restrictions On A Piece Of Content By Operation. This Method Is Similar To Get Restrictions Except That The Operations Are Properties Of The Return Object, Rather Than Items In A Results Array. Permission To View The Content Is Required.
Get Content Restrictions For Operation
-
Returns The Restrictions On A Piece Of Content For A Given Operation (Read Or Update). Permission To View The Content Is Required.
Get Content State
-
Gets The Current Content State Of The Draft Or Current Version Of Content. To Specify The Draft Version, Set The Parameter Status To Draft, Otherwise Archived Or Current Will Get The Relevant Published State. Permission To View The Content Is Required.
Get Content State Settings For Space
-
Get Object Describing Whether Content States Are Allowed At All, If Custom Content States Or Space Content States Are Restricted, And A List Of Space Content States Allowed For The Space If They Are Not Restricted. 'Admin' Permission For The Space Is Required.
Get Content Template
-
Returns A Content Template. This Includes Information About Template, Like The Name, The Space Or Blueprint That The Template Is In, The Body Of The Template, And More.
Get Content Templates
-
Returns All Content Templates. Use This Method To Retrieve All Global Content Templates Or All Content Templates In A Space.
Get Content Watch Status
-
Returns Whether A User Is Watching A Piece Of Content. Choose The User By Doing One Of The Following - Specify A User Via A Query Parameter (Use The AccountId To Identify The User), Do Not Specify A User (The Currently Logged-In User Will Be Used). 'Confluence Administrator' Global Permission If Specifying A User, Otherwise Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.
Get Current User
-
Retrieves The Profile Of The Currently Authenticated User, Including Display Name, Account ID, Email, Profile Picture, And Locale Settings.
Get Custom Content By Id
-
Returns A Specific Piece Of Custom Content.
Get Custom Content By Type
-
Returns All Custom Content For A Given Type. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available Through The Next URL Present In The Link Response Header.
Get Custom Content By Type In Blog Post
-
Returns All Custom Content For A Given Type Within A Given Blogpost. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available Through The Next URL Present In The Link Response Header.
Get Custom Content By Type In Page
-
Returns All Custom Content For A Given Type Within A Given Page. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available Through The Next URL Present In The Link Response Header.
Get Custom Content By Type In Space
-
Returns All Custom Content For A Given Type Within A Given Space. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available Through The Next URL Present In The Link Response Header.
Get Custom Content Comments
-
Retrieves Footer Comments For A Specific Custom Content Item With Pagination Support.
Get Custom Content Labels
-
Retrieves All Labels Associated With A Specific Piece Of Custom Content.
Get Custom Content States
-
Get Custom Content States That Authenticated User Has Created. Must Have User Authentication.
Get Data Policy Metadata For The Workspace
-
Returns Data Policy Metadata For The Workspace. This Is An EXPERIMENTAL Endpoint That Requires OAuth 2.0 App Authentication (Not Basic Auth). Only Atlassian Apps With The 'Read:Configuration:Confluence' OAuth Scope Can Make This Request. This Endpoint May Return 404 If Data Policies Are Not Enabled In Your Confluence Instance, If You'Re Using Basic Authentication Instead Of OAuth 2.0, Or If The App Doesn'T Have The Required Permissions. Requires 'Can Use' Global Permission.
Get Database
-
Retrieves Detailed Information About A Specific Database By Its ID.
Get Database Classification Level
-
Retrieves The Classification Level Assigned To A Specific Database.
Get Descendants Of A Database
-
Returns Descendants In The Content Tree For A Given Database By ID In Top-To-Bottom Order. 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.
Get Descendants Of A Smart Link
-
Returns Descendants In The Content Tree For A Given Smart Link By ID In Top-To-Bottom Order. 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.
Get Descendants Of A Whiteboard
-
Returns Descendants In The Content Tree For A Given Whiteboard By ID In Top-To-Bottom Order. 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.
Get Descendants Of Folder
-
Returns Descendants In The Content Tree For A Given Folder By ID In Top-To-Bottom Order. 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.
Get Descendants Of Page
-
Returns Descendants In The Content Tree For A Given Page By ID In Top-To-Bottom Order. 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.
Get Direct Children Of A Database
-
Returns All Direct Children For A Given Database By ID. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available Through The Next URL Present In The Link Response Header. Returns Minimal Information About Each Child. To Fetch More Details, Use A Related Endpoint Based On The Content Type.
Get Direct Children Of A Folder
-
Returns All Direct Children For A Given Folder By ID. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available Through The Next URL Present In The Link Response Header. Returns Minimal Information About Each Child. To Fetch More Details, Use A Related Endpoint Based On The Content Type.
Get Direct Children Of A Page
-
Returns All Direct Children For A Given Page By ID. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available Through The Next URL Present In The Link Response Header. Returns Minimal Information About Each Child. To Fetch More Details, Use A Related Endpoint Based On The Content Type.
Get Direct Children Of A Smart Link
-
Returns All Direct Children For A Given Smart Link By ID. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available Through The Next URL Present In The Link Response Header. Returns Minimal Information About Each Child. To Fetch More Details, Use A Related Endpoint Based On The Content Type.
Get Direct Children Of A Whiteboard
-
Returns All Direct Children For A Given Whiteboard By ID. The Number Of Results Is Limited By The Limit Parameter And Additional Results (If Available) Will Be Available Through The Next URL Present In The Link Response Header. Returns Minimal Information About Each Child. To Fetch More Details, Use A Related Endpoint Based On The Content Type.
Get Folder
-
Retrieves Detailed Information About A Specific Folder By Its Numeric ID.
Get Footer Comment By Id
-
Retrieves Detailed Information About A Specific Footer Comment By Its ID.
Get Footer Comments For Blog Post
-
Retrieves Root Footer Comments For A Specific Blog Post With Pagination Support.
Get Footer Comments For Page
-
Retrieves Root Footer Comments For A Specific Page With Pagination Support.
Get Forge App Properties.
-
Gets Forge App Properties. This API Can Only Be Accessed Using AsApp() Requests From Forge. Regular API Calls With Bearer Tokens Will Return 401 Unauthorized. This Endpoint Requires OAuth 2.0 Scope Read:App-Data:Confluence And Can Only Be Used Within Forge App Context.
Get Global Settings
-
Get Confluence Global Settings, Showing Instance-Wide Configuration Options For Features, Security, And Behavior.
Get Global Theme
-
Get The Global Theme Applied To The Entire Confluence Instance, Showing Default Styling For All Spaces. Returns The Globally Assigned Theme.
Get Group By ID
-
Returns A User Group For A Given Group Id.
Get Group Members By ID
-
Returns The Users That Are Members Of A Group. Use Updated Get Group API
Get Group Memberships For User
-
Retrieves All Groups That A Specific User Is A Member Of, Useful For Permission Auditing And Access Management.
Get Inline Comment By Id
-
Retrieves Detailed Information About A Specific Inline Comment By Its ID.
Get Inline Comments For Blog Post
-
Retrieves Root Inline Comments For A Specific Blog Post With Pagination Support.
Get Inline Comments For Page
-
Retrieves Root Inline Comments For A Specific Page With Pagination Support.
Get Label Information
-
Returns Label Information And A List Of Contents Associated With The Label. Only Contents That The User Is Permitted To View Is Returned.
Get Label Watch Status
-
Returns Whether A User Is Watching A Label. Choose The User By Doing One Of The Following - Specify A User Via A Query Parameter (Use The AccountId To Identify The User), Do Not Specify A User (The Currently Logged-In User Will Be Used). 'Confluence Administrator' Global Permission If Specifying A User, Otherwise Permission To Access The Confluence Site ('Can Use' Global Permission) Is Required.
Get Like Count For Blog Post
-
Retrieves The Total Number Of Likes For A Specific Blog Post.
Get Like Count For Footer Comment
-
Retrieves The Total Number Of Likes For A Specific Footer Comment.
Get Like Count For Inline Comment
-
Retrieves The Total Number Of Likes For A Specific Inline Comment.
Get Like Count For Page
-
Retrieves The Total Number Of Likes For A Specific Page.
Get Long-Running Task
-
Returns Information About An Active Long-Running Task (E.G. Space Export), Such As How Long It Has Been Running And The Percentage Of The Task That Has Completed.
Get Long-Running Tasks
-
Returns Information About All Active Long-Running Tasks (E.G. Space Export), Such As How Long Each Task Has Been Running And The Percentage Of Each Task That Has Completed.
Get Look And Feel Settings
-
Returns The Look And Feel Settings For The Site Or A Single Space. This Includes Attributes Such As The Color Scheme, Padding, And Border Radius. The Look And Feel Settings For A Space Can Be Inherited From The Global Look And Feel Settings Or Provided By A Theme.
Get Macro Body And Convert Asynchronously
-
Returns Async Id Of The Conversion Task Which Will Convert The Macro Into A Content Body Of The Desired Format. The Result Will Be Available For 5 Minutes After Completion Of The Conversion. When A Macro Is Created In A New Version Of Content, Confluence Will Generate A Random ID For It, Unless An ID Is Specified (By An App). The Macro ID Will Look Similar To '884bd9-0cb8-41d5-98be-F80943c14f96'. The ID Is Then Persisted As New Versions Of Content Are Created, And Is Only Modified By Confluence If There Are Conflicting IDs. For Forge Macros, The Value For Macro ID Is The Local ID Of That Particular ADF Node. Currently, The Following Conversions Are Allowed - Export_view, Styled_view, View. Note, To Preserve Backwards Compatibility This Resource Will Also Match On The Hash Of The Macro Body, Even If A Macro ID Is Found. This Backwards Compatibility Logic Does Not Apply To Forge Macros. Permission To View The Content That The Macro Is In Is Required.
Get Macro Body And Convert Synchronously
-
Returns The Body Of A Macro In Format Specified In Path, For The Given Macro ID. This Includes Information Like The Name Of The Macro, The Body Of The Macro, And Any Macro Parameters. When A Macro Is Created In A New Version Of Content, Confluence Will Generate A Random ID For It, Unless An ID Is Specified (By An App). The Macro ID Will Look Similar To '50884bd9-0cb8-41d5-98be-F80943c14f96'. The ID Is Then Persisted As New Versions Of Content Are Created, And Is Only Modified By Confluence If There Are Conflicting IDs. For Forge Macros, The Value For Macro ID Is The Local ID Of That Particular ADF Node. Note, To Preserve Backwards Compatibility This Resource Will Also Match On The Hash Of The Macro Body, Even If A Macro ID Is Found. This Backwards Compatibility Logic Does Not Apply To Forge Macros. Permission To View The Content That The Macro Is In Is Required.
Get Macro Body By Macro ID
-
Returns The Body Of A Macro In Storage Format, For The Given Macro ID. This Includes Information Like The Name Of The Macro, The Body Of The Macro, And Any Macro Parameters. This Method Is Mainly Used By Cloud Apps. When A Macro Is Created In A New Version Of Content, Confluence Will Generate A Random ID For It, Unless An ID Is Specified (By An App). The Macro ID Will Look Similar To '50884bd9-0cb8-41d5-98be-F80943c14f96'. The ID Is Then Persisted As New Versions Of Content Are Created, And Is Only Modified By Confluence If There Are Conflicting IDs. For Forge Macros, The Value For Macro ID Is The Local ID Of That Particular ADF Node. Note, To Preserve Backwards Compatibility This Resource Will Also Match On The Hash Of The Macro Body, Even If A Macro ID Is Found. This Backwards Compatibility Logic Does Not Apply To Forge Macros. Permission To View The Content That The Macro Is In Is Required.
Get Modules
-
Returns All Modules Registered Dynamically By The Calling App. Only Connect Apps Can Make This Request.
Get Multiple Users Using IDs
-
Retrieves Profile Details For Multiple Users In A Single Request By Their Account IDs, With A Maximum Of 100 Users Per Request.
Get Page
-
Retrieves Detailed Information About A Specific Page By Its Numeric ID, Including Optional Content Body, Labels, Properties, And Collaborators.
Get Page Classification Level
-
Retrieves The Classification Level Assigned To A Specific Page.
Get Page Labels
-
Retrieves All Labels Associated With A Specific Page.
Get Pages For Label
-
Retrieves All Pages That Have A Specific Label Attached, With Optional Filtering By Space.
Get Pages In Space
-
Retrieves All Pages Within A Specific Confluence Space, With Optional Filtering By Depth, Status, Or Title.
Get Permitted Operations For A Database
-
Returns The Permitted Operations On Specific Database.
Get Permitted Operations For A Folder
-
Returns The Permitted Operations On Specific Folder.
Get Permitted Operations For A Smart Link In The Content Tree
-
Returns The Permitted Operations On Specific Smart Link In The Content Tree.
Get Permitted Operations For A Whiteboard
-
Returns The Permitted Operations On Specific Whiteboard.
Get Permitted Operations For Attachment
-
Returns The Permitted Operations On Specific Attachment.
Get Permitted Operations For Blog Post
-
Returns The Permitted Operations On Specific Blog Post.
Get Permitted Operations For Custom Content
-
Returns The Permitted Operations On Specific Custom Content.