Skip to content

confluence.js

Main Navigation Guide Recipes API Migration

English

Русский

English

Русский

Appearance

Sidebar Navigation

API Reference

core

Interfaces

ApiErrorOptions

Client

OAuth2Manager

OAuth2ManagerOptions

OAuthErrorOptions

ParseCallbackUrlOptions

RateLimitErrorOptions

RetryOptions

Type Aliases

AuthBasic

AuthBearer

AuthOAuth2

Buffer

HttpMethod

SendRequestOptions

Variables

authOAuth2Schema

authSchema

BufferSchema

clientConfigSchema

httpMethodSchema

sendRequestOptionsSchema

Functions

apiObject

createClient

createOAuth2Manager

mimeTypeFor

withRetry

index

Classes

ApiError

AuthError

ConfigError

ForbiddenError

NetworkError

NotFoundError

OAuthError

RateLimitError

SchemaMismatchError

ScopeError

ServerError

Interfaces

AccessibleResource

CallbackParams

OAuth2TokenResponse

TokenRefreshEvent

Type Aliases

AttachmentContent

AttachmentInput

Auth

ClientConfig

MultipartRequestBody

OnTokenRefresh

Functions

createMultipartRequestBody

exchangeAuthorizationCode

generateAuthorizationUrl

getAccessibleResources

isApiError

isAuthError

isConfigError

isForbiddenError

isNetworkError

isNotFoundError

isOAuthError

isRateLimitError

isReauthorizationRequired

isSchemaMismatchError

isScopeError

isServerError

parseCallbackUrl

refreshOAuth2Token

toFormDataFile

v1

api

analytics

Functions

getViewers

getViews

audit

Functions

createAuditRecord

exportAuditRecords

getAuditRecords

getAuditRecordsForTimePeriod

getRetentionPeriod

setRetentionPeriod

content

Functions

archivePages

publishLegacyDraft

publishSharedDraft

searchContentByCQL

contentAttachments

Functions

createAttachment

createOrUpdateAttachments

downloadAttatchment

updateAttachmentData

updateAttachmentProperties

contentBody

Functions

asyncConvertContentBodyRequest

asyncConvertContentBodyResponse

bulkAsyncConvertContentBodyRequest

bulkAsyncConvertContentBodyResponse

contentChildrenAndDescendants

Functions

copyPage

copyPageHierarchy

getContentDescendants

getDescendantsOfType

movePage

contentLabels

Functions

addLabelsToContent

removeLabelFromContent

removeLabelFromContentUsingQueryParameter

contentMacroBody

Functions

getAndAsyncConvertMacroBodyByMacroId

getAndConvertMacroBodyByMacroId

getMacroBodyByMacroId

contentPermissions

Functions

checkContentPermission

contentRestrictions

Functions

addGroupToContentRestrictionByGroupId

addRestrictions

addUserToContentRestriction

deleteRestrictions

getContentRestrictionStatusForUser

getIndividualGroupRestrictionStatusByGroupId

getRestrictions

getRestrictionsByOperation

getRestrictionsForOperation

removeGroupFromContentRestriction

removeUserFromContentRestriction

updateRestrictions

contentStates

Functions

getAvailableContentStates

getContentState

getContentStateSettings

getContentsWithState

getCustomContentStates

getSpaceContentStates

removeContentState

setContentState

contentVersions

Functions

deleteContentVersion

restoreContentVersion

contentWatches

Functions

addContentWatcher

addLabelWatcher

addSpaceWatcher

getContentWatchStatus

getWatchersForSpace

getWatchesForPage

getWatchesForSpace

isWatchingLabel

isWatchingSpace

removeContentWatcher

removeLabelWatcher

removeSpaceWatch

dynamicModules

Functions

getModules

registerModules

removeModules

experimental

Functions

addLabelsToSpace

deleteLabelFromSpace

deletePageTree

getLabelsForSpace

group

Functions

addUserToGroupByGroupId

createGroup

getGroupByGroupId

getGroupMembersByGroupId

getGroups

removeGroupById

removeMemberFromGroupByGroupId

searchGroups

labelInfo

Functions

getAllLabelContent

longRunningTask

Functions

getTask

getTasks

relation

Functions

createRelationship

deleteRelationship

findSourcesForTarget

findTargetFromSource

getRelationship

search

Functions

searchByCQL

searchUser

settings

Functions

getLookAndFeelSettings

getSystemInfo

resetLookAndFeelSettings

updateLookAndFeel

updateLookAndFeelSettings

space

Functions

createPrivateSpace

createSpace

deleteSpace

updateSpace

spacePermissions

Functions

addCustomContentPermissions

addPermissionToSpace

removePermission

spaceSettings

Functions

getSpaceSettings

updateSpaceSettings

template

Functions

createContentTemplate

getBlueprintTemplates

getContentTemplate

getContentTemplates

removeTemplate

updateContentTemplate

themes

Functions

getGlobalTheme

getSpaceTheme

getTheme

getThemes

resetSpaceTheme

setSpaceTheme

userProperties

Functions

createUserProperty

deleteUserProperty

getUserProperties

getUserProperty

updateUserProperty

users

Functions

getAnonymousUser

getBulkUserLookup

getCurrentUser

getGroupMembershipsForUser

getPrivacyUnsafeUserEmail

getPrivacyUnsafeUserEmailBulk

getUser

createV1Client

Type Aliases

V1Client

Functions

createV1Client

v2

api

adminKey

Functions

disableAdminKey

enableAdminKey

getAdminKey

ancestors

Functions

getDatabaseAncestors

getFolderAncestors

getPageAncestors

getSmartLinkAncestors

getWhiteboardAncestors

appProperties

Functions

deleteForgeAppProperty

getForgeAppProperties

getForgeAppProperty

putForgeAppProperty

attachment

Functions

deleteAttachment

getAttachmentById

getAttachments

getAttachmentThumbnailById

getBlogpostAttachments

getCustomContentAttachments

getLabelAttachments

getPageAttachments

blogPost

Functions

createBlogPost

deleteBlogPost

getBlogPostById

getBlogPosts

getBlogPostsInSpace

getLabelBlogPosts

updateBlogPost

children

Functions

getChildCustomContent

getChildPages

getDatabaseDirectChildren

getFolderDirectChildren

getPageDirectChildren

getSmartLinkDirectChildren

getWhiteboardDirectChildren

classificationLevel

Functions

deleteSpaceDefaultClassificationLevel

getBlogPostClassificationLevel

getClassificationLevels

getDatabaseClassificationLevel

getPageClassificationLevel

getSpaceDefaultClassificationLevel

getWhiteboardClassificationLevel

postBlogPostClassificationLevel

postDatabaseClassificationLevel

postPageClassificationLevel

postWhiteboardClassificationLevel

putBlogPostClassificationLevel

putDatabaseClassificationLevel

putPageClassificationLevel

putSpaceDefaultClassificationLevel

putWhiteboardClassificationLevel

comment

Functions

createFooterComment

createInlineComment

deleteFooterComment

deleteInlineComment

getAttachmentComments

getBlogPostFooterComments

getBlogPostInlineComments

getCustomContentComments

getFooterCommentById

getFooterCommentChildren

getFooterComments

getInlineCommentById

getInlineCommentChildren

getInlineComments

getPageFooterComments

getPageInlineComments

updateFooterComment

updateInlineComment

content

Functions

convertContentIdsToContentTypes

contentProperties

Functions

createAttachmentProperty

createBlogpostProperty

createCommentProperty

createCustomContentProperty

createDatabaseProperty

createFolderProperty

createPageProperty

createSmartLinkProperty

createWhiteboardProperty

deleteAttachmentPropertyById

deleteBlogpostPropertyById

deleteCommentPropertyById

deleteCustomContentPropertyById

deleteDatabasePropertyById

deleteFolderPropertyById

deletePagePropertyById

deleteSmartLinkPropertyById

deleteWhiteboardPropertyById

getAttachmentContentProperties

getAttachmentContentPropertiesById

getBlogpostContentProperties

getBlogpostContentPropertiesById

getCommentContentProperties

getCommentContentPropertiesById

getCustomContentContentProperties

getCustomContentContentPropertiesById

getDatabaseContentProperties

getDatabaseContentPropertiesById

getFolderContentProperties

getFolderContentPropertiesById

getPageContentProperties

getPageContentPropertiesById

getSmartLinkContentProperties

getSmartLinkContentPropertiesById

getWhiteboardContentProperties

getWhiteboardContentPropertiesById

updateAttachmentPropertyById

updateBlogpostPropertyById

updateCommentPropertyById

updateCustomContentPropertyById

updateDatabasePropertyById

updateFolderPropertyById

updatePagePropertyById

updateSmartLinkPropertyById

updateWhiteboardPropertyById

customContent

Functions

createCustomContent

deleteCustomContent

getCustomContentById

getCustomContentByType

getCustomContentByTypeInBlogPost

getCustomContentByTypeInPage

getCustomContentByTypeInSpace

updateCustomContent

database

Functions

createDatabase

deleteDatabase

getDatabaseById

dataPolicies

Functions

getDataPolicyMetadata

getDataPolicySpaces

descendants

Functions

getDatabaseDescendants

getFolderDescendants

getPageDescendants

getSmartLinkDescendants

getWhiteboardDescendants

folder

Functions

createFolder

deleteFolder

getFolderById

label

Functions

getAttachmentLabels

getBlogPostLabels

getCustomContentLabels

getLabels

getPageLabels

getSpaceContentLabels

getSpaceLabels

like

Functions

getBlogPostLikeCount

getBlogPostLikeUsers

getFooterLikeCount

getFooterLikeUsers

getInlineLikeCount

getInlineLikeUsers

getPageLikeCount

getPageLikeUsers

operation

Functions

getAttachmentOperations

getBlogPostOperations

getCustomContentOperations

getDatabaseOperations

getFolderOperations

getFooterCommentOperations

getInlineCommentOperations

getPageOperations

getSmartLinkOperations

getSpaceOperations

getWhiteboardOperations

page

Functions

createPage

deletePage

getLabelPages

getPageById

getPages

getPagesInSpace

updatePage

updatePageTitle

redactions

Functions

postRedactBlog

postRedactPage

smartLink

Functions

createSmartLink

deleteSmartLink

getSmartLinkById

space

Functions

createSpace

getSpaceById

getSpaces

spacePermissions

Functions

getAvailableSpacePermissions

getSpacePermissionsAssignments

spacePermissionTransition

Functions

bulkAssignSpacePermissionRoles

bulkRemoveSpacePermissionAccess

generateSpacePermissionCombinations

getSpacePermissionTransitionTaskStatus

listSpacePermissionCombinations

spaceProperties

Functions

createSpaceProperty

deleteSpacePropertyById

getSpaceProperties

getSpacePropertyById

updateSpacePropertyById

spaceRoles

Functions

createSpaceRole

deleteSpaceRole

getAvailableSpaceRoles

getSpaceRoleAssignments

getSpaceRoleMode

getSpaceRolesById

setSpaceRoleAssignments

updateSpaceRole

task

Functions

getTaskById

getTasks

updateTask

user

Functions

checkAccessByEmail

createBulkUserLookup

inviteByEmail

version

Functions

getAttachmentVersionDetails

getAttachmentVersions

getBlogPostVersionDetails

getBlogPostVersions

getCustomContentVersionDetails

getCustomContentVersions

getFooterCommentVersionDetails

getFooterCommentVersions

getInlineCommentVersionDetails

getInlineCommentVersions

getPageVersionDetails

getPageVersions

whiteboard

Functions

createWhiteboard

deleteWhiteboard

getWhiteboardById

createV2Client

Type Aliases

V2Client

Functions

createV2Client

On this page

v1/models/accountId

Type Aliases

AccountId

Variables

AccountIdSchema

Edit this page on GitHub

Pager

Nextcore