Confluence
Interact with Confluence
Integrate Confluence into the workflow. Can read, create, update, delete pages, manage comments, attachments, labels, and search content.
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | Confluence page ID |
title | string | Page title |
content | string | Page content with HTML tags stripped |
status | string | Page status (current, archived, trashed, draft) |
spaceId | string | ID of the space containing the page |
parentId | string | ID of the parent page |
authorId | string | Account ID of the page author |
createdAt | string | ISO 8601 timestamp when the page was created |
url | string | URL to view the page in Confluence |
body | object | Raw page body content in storage format |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
version | object | Page version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
title | string | No | No description |
content | string | No | No description |
version | number | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of update |
pageId | string | Confluence page ID |
title | string | Updated page title |
status | string | Page status |
spaceId | string | Space ID |
body | object | Page body content in storage format |
↳ storage | object | Body in storage format (Confluence markup) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ view | object | Body in view format (rendered HTML) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ atlas_doc_format | object | Body in Atlassian Document Format (ADF) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
version | object | Page version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
url | string | URL to view the page in Confluence |
success | boolean | Update operation success status |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
spaceId | string | Yes | No description |
title | string | Yes | No description |
content | string | Yes | No description |
parentId | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of creation |
pageId | string | Created page ID |
title | string | Page title |
status | string | Page status |
spaceId | string | Space ID |
parentId | string | Parent page ID |
body | object | Page body content |
↳ storage | object | Body in storage format (Confluence markup) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ view | object | Body in view format (rendered HTML) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ atlas_doc_format | object | Body in Atlassian Document Format (ADF) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
version | object | Page version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
url | string | Page URL |
Delete a Confluence page. By default moves to trash; use purge=true to permanently delete.
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
purge | boolean | No | If true, permanently deletes the page instead of moving to trash (default: false) |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of deletion |
pageId | string | Deleted page ID |
deleted | boolean | Deletion status |
List all pages within a specific Confluence space. Supports pagination and filtering by status.
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
spaceId | string | Yes | No description |
limit | number | No | No description |
status | string | No | No description |
bodyFormat | string | No | Format for page body content: storage, atlas_doc_format, or view. If not specified, body is not included. |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
pages | array | Array of pages in the space |
↳ id | string | Unique page identifier |
↳ title | string | Page title |
↳ status | string | Page status (e.g., current, archived, trashed, draft) |
↳ spaceId | string | ID of the space containing the page |
↳ parentId | string | ID of the parent page (null if top-level) |
↳ authorId | string | Account ID of the page author |
↳ createdAt | string | ISO 8601 timestamp when the page was created |
↳ version | object | Page version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
↳ body | object | Page body content (if bodyFormat was specified) |
↳ storage | object | Body in storage format (Confluence markup) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ view | object | Body in view format (rendered HTML) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ atlas_doc_format | object | Body in Atlassian Document Format (ADF) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ webUrl | string | URL to view the page in Confluence |
nextCursor | string | Cursor for fetching the next page of results |
Get all child pages of a specific Confluence page. Useful for navigating page hierarchies.
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
limit | number | No | No description |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
parentId | string | ID of the parent page |
children | array | Array of child pages |
↳ id | string | Child page ID |
↳ title | string | Child page title |
↳ status | string | Page status |
↳ spaceId | string | Space ID |
↳ childPosition | number | Position among siblings |
↳ webUrl | string | URL to view the page |
nextCursor | string | Cursor for fetching the next page of results |
Get the ancestor (parent) pages of a specific Confluence page. Returns the full hierarchy from the page up to the root.
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
limit | number | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | ID of the page whose ancestors were retrieved |
ancestors | array | Array of ancestor pages, ordered from direct parent to root |
↳ id | string | Ancestor page ID |
↳ title | string | Ancestor page title |
↳ status | string | Page status |
↳ spaceId | string | Space ID |
↳ webUrl | string | URL to view the page |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
limit | number | No | No description |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | ID of the page |
versions | array | Array of page versions |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
nextCursor | string | Cursor for fetching the next page of results |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
versionNumber | number | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | ID of the page |
title | string | Page title at this version |
content | string | Page content with HTML tags stripped at this version |
version | object | Detailed version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
↳ contentTypeModified | boolean | Whether the content type was modified in this version |
↳ collaborators | array | List of collaborator account IDs for this version |
↳ prevVersion | number | Previous version number |
↳ nextVersion | number | Next version number |
body | object | Raw page body content in storage format at this version |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
limit | number | No | No description |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | ID of the page |
properties | array | Array of content properties |
↳ id | string | Property ID |
↳ key | string | Property key |
↳ value | json | Property value (can be any JSON) |
↳ version | object | Version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
nextCursor | string | Cursor for fetching the next page of results |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
key | string | Yes | No description |
value | json | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | ID of the page |
propertyId | string | ID of the created property |
key | string | Property key |
value | json | Property value |
version | object | Version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
propertyId | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | ID of the page |
propertyId | string | ID of the deleted property |
deleted | boolean | Deletion status |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
query | string | Yes | No description |
limit | number | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of search |
results | array | Array of search results |
↳ id | string | Unique content identifier |
↳ title | string | Content title |
↳ type | string | Content type (e.g., page, blogpost, attachment, comment) |
↳ status | string | Content status (e.g., current) |
↳ url | string | URL to view the content in Confluence |
↳ excerpt | string | Text excerpt matching the search query |
↳ spaceKey | string | Key of the space containing the content |
↳ space | object | Space information for the content |
↳ id | string | Space identifier |
↳ key | string | Space key |
↳ name | string | Space name |
↳ lastModified | string | ISO 8601 timestamp of last modification |
↳ entityType | string | Entity type identifier (e.g., content, space) |
Search for content within a specific Confluence space. Optionally filter by text query and content type.
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
spaceKey | string | Yes | The key of the Confluence space to search in (e.g., "ENG", "HR") |
query | string | No | No description |
contentType | string | No | No description |
limit | number | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaceKey | string | The space key that was searched |
totalSize | number | Total number of matching results |
results | array | Array of search results |
↳ id | string | Unique content identifier |
↳ title | string | Content title |
↳ type | string | Content type (e.g., page, blogpost, attachment, comment) |
↳ status | string | Content status (e.g., current) |
↳ url | string | URL to view the content in Confluence |
↳ excerpt | string | Text excerpt matching the search query |
↳ spaceKey | string | Key of the space containing the content |
↳ space | object | Space information for the content |
↳ id | string | Space identifier |
↳ key | string | Space key |
↳ name | string | Space name |
↳ lastModified | string | ISO 8601 timestamp of last modification |
↳ entityType | string | Entity type identifier (e.g., content, space) |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
limit | number | No | No description |
status | string | No | No description |
sort | string | No | Sort order: created-date, -created-date, modified-date, -modified-date, title, -title |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
blogPosts | array | Array of blog posts |
↳ id | string | Blog post ID |
↳ title | string | Blog post title |
↳ status | string | Blog post status |
↳ spaceId | string | Space ID |
↳ authorId | string | Author account ID |
↳ createdAt | string | Creation timestamp |
↳ version | object | Version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
↳ webUrl | string | URL to view the blog post |
nextCursor | string | Cursor for fetching the next page of results |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
blogPostId | string | Yes | No description |
bodyFormat | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
id | string | Blog post ID |
title | string | Blog post title |
status | string | Blog post status |
spaceId | string | Space ID |
authorId | string | Author account ID |
createdAt | string | Creation timestamp |
version | object | Version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
body | object | Blog post body content in requested format(s) |
↳ storage | object | Body in storage format (Confluence markup) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ view | object | Body in view format (rendered HTML) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ atlas_doc_format | object | Body in Atlassian Document Format (ADF) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
webUrl | string | URL to view the blog post |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
spaceId | string | Yes | No description |
title | string | Yes | No description |
content | string | Yes | No description |
status | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
id | string | Created blog post ID |
title | string | Blog post title |
status | string | Blog post status |
spaceId | string | Space ID |
authorId | string | Author account ID |
body | object | Blog post body content |
↳ storage | object | Body in storage format (Confluence markup) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ view | object | Body in view format (rendered HTML) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ atlas_doc_format | object | Body in Atlassian Document Format (ADF) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
version | object | Blog post version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
webUrl | string | URL to view the blog post |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
spaceId | string | Yes | No description |
limit | number | No | No description |
status | string | No | No description |
bodyFormat | string | No | No description |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
blogPosts | array | Array of blog posts in the space |
↳ id | string | Blog post ID |
↳ title | string | Blog post title |
↳ status | string | Blog post status |
↳ spaceId | string | Space ID |
↳ authorId | string | Author account ID |
↳ createdAt | string | Creation timestamp |
↳ version | object | Version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
↳ body | object | Blog post body content |
↳ storage | object | Body in storage format (Confluence markup) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ view | object | Body in view format (rendered HTML) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ atlas_doc_format | object | Body in Atlassian Document Format (ADF) |
↳ value | string | The content value in the specified format |
↳ representation | string | Content representation type |
↳ webUrl | string | URL to view the blog post |
nextCursor | string | Cursor for fetching the next page of results |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
comment | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of creation |
commentId | string | Created comment ID |
pageId | string | Page ID |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
limit | number | No | No description |
bodyFormat | string | No | Format for the comment body: storage, atlas_doc_format, view, or export_view (default: storage) |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
comments | array | Array of Confluence comments |
↳ id | string | Unique comment identifier |
↳ status | string | Comment status (e.g., current) |
↳ title | string | Comment title |
↳ pageId | string | ID of the page the comment belongs to |
↳ blogPostId | string | ID of the blog post the comment belongs to |
↳ parentCommentId | string | ID of the parent comment |
↳ body | object | Comment body content |
↳ value | string | Comment body content |
↳ representation | string | Content representation format (e.g., storage, view) |
↳ createdAt | string | ISO 8601 timestamp when the comment was created |
↳ authorId | string | Account ID of the comment author |
↳ version | object | Comment version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
nextCursor | string | Cursor for fetching the next page of results |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
commentId | string | Yes | No description |
comment | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of update |
commentId | string | Updated comment ID |
updated | boolean | Update status |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
commentId | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of deletion |
commentId | string | Deleted comment ID |
deleted | boolean | Deletion status |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
file | file | Yes | No description |
fileName | string | No | No description |
comment | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of upload |
attachmentId | string | Uploaded attachment ID |
title | string | Attachment file name |
fileSize | number | File size in bytes |
mediaType | string | MIME type of the attachment |
downloadUrl | string | Download URL for the attachment |
pageId | string | Page ID the attachment was added to |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
limit | number | No | No description |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
attachments | array | Array of Confluence attachments |
↳ id | string | Unique attachment identifier (prefixed with "att") |
↳ title | string | Attachment file name |
↳ status | string | Attachment status (e.g., current, archived, trashed) |
↳ mediaType | string | MIME type of the attachment |
↳ fileSize | number | File size in bytes |
↳ downloadUrl | string | URL to download the attachment |
↳ webuiUrl | string | URL to view the attachment in Confluence UI |
↳ pageId | string | ID of the page the attachment belongs to |
↳ blogPostId | string | ID of the blog post the attachment belongs to |
↳ comment | string | Comment/description of the attachment |
↳ version | object | Attachment version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
nextCursor | string | Cursor for fetching the next page of results |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
attachmentId | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of deletion |
attachmentId | string | Deleted attachment ID |
deleted | boolean | Deletion status |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
limit | number | No | No description |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | Timestamp of retrieval |
labels | array | Array of labels on the page |
↳ id | string | Unique label identifier |
↳ name | string | Label name |
↳ prefix | string | Label prefix/type (e.g., global, my, team) |
nextCursor | string | Cursor for fetching the next page of results |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
labelName | string | Yes | No description |
prefix | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | Page ID that the label was added to |
labelName | string | Name of the added label |
labelId | string | ID of the added label |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
labelName | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
pageId | string | Page ID the label was removed from |
labelName | string | Name of the removed label |
deleted | boolean | Deletion status |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
labelId | string | Yes | No description |
limit | number | No | No description |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
labelId | string | ID of the label |
pages | array | Array of pages with this label |
↳ id | string | Unique page identifier |
↳ title | string | Page title |
↳ status | string | Page status (e.g., current, archived, trashed, draft) |
↳ spaceId | string | ID of the space containing the page |
↳ parentId | string | ID of the parent page (null if top-level) |
↳ authorId | string | Account ID of the page author |
↳ createdAt | string | ISO 8601 timestamp when the page was created |
↳ version | object | Page version information |
↳ number | number | Version number |
↳ message | string | Version message |
↳ minorEdit | boolean | Whether this is a minor edit |
↳ authorId | string | Account ID of the version author |
↳ createdAt | string | ISO 8601 timestamp of version creation |
nextCursor | string | Cursor for fetching the next page of results |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
spaceId | string | Yes | No description |
limit | number | No | No description |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaceId | string | ID of the space |
labels | array | Array of labels on the space |
↳ id | string | Unique label identifier |
↳ name | string | Label name |
↳ prefix | string | Label prefix/type (e.g., global, my, team) |
nextCursor | string | Cursor for fetching the next page of results |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
spaceId | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaceId | string | Space ID |
name | string | Space name |
key | string | Space key |
type | string | Space type (global, personal) |
status | string | Space status (current, archived) |
url | string | URL to view the space in Confluence |
authorId | string | Account ID of the space creator |
createdAt | string | ISO 8601 timestamp when the space was created |
homepageId | string | ID of the space homepage |
description | object | Space description content |
↳ value | string | Description text content |
↳ representation | string | Content representation format (e.g., plain, view, storage) |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
name | string | Yes | No description |
key | string | Yes | No description |
description | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaceId | string | Created space ID |
name | string | Space name |
key | string | Space key |
type | string | Space type |
status | string | Space status |
url | string | URL to view the space |
homepageId | string | Homepage ID |
description | object | Space description |
↳ value | string | Description text content |
↳ representation | string | Content representation format (e.g., plain, view, storage) |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
spaceId | string | Yes | No description |
name | string | No | No description |
description | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaceId | string | Updated space ID |
name | string | Space name |
key | string | Space key |
type | string | Space type |
status | string | Space status |
url | string | URL to view the space |
description | object | Space description |
↳ value | string | Description text content |
↳ representation | string | Content representation format (e.g., plain, view, storage) |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
spaceId | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaceId | string | Deleted space ID |
deleted | boolean | Deletion status |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
limit | number | No | No description |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaces | array | Array of Confluence spaces |
↳ id | string | Unique space identifier |
↳ key | string | Space key (short identifier used in URLs) |
↳ name | string | Space name |
↳ type | string | Space type (e.g., global, personal) |
↳ status | string | Space status (e.g., current, archived) |
↳ authorId | string | Account ID of the space creator |
↳ createdAt | string | ISO 8601 timestamp when the space was created |
↳ homepageId | string | ID of the space homepage |
↳ description | object | Space description |
↳ value | string | Description text content |
↳ representation | string | Content representation format (e.g., plain, view, storage) |
nextCursor | string | Cursor for fetching the next page of results |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
spaceId | string | Yes | No description |
limit | number | No | No description |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
properties | array | Array of space properties |
↳ id | string | Property ID |
↳ key | string | Property key |
↳ value | json | Property value |
spaceId | string | Space ID |
nextCursor | string | Cursor for fetching the next page of results |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
spaceId | string | Yes | No description |
key | string | Yes | No description |
value | json | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
propertyId | string | Created property ID |
key | string | Property key |
value | json | Property value |
spaceId | string | Space ID |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
spaceId | string | Yes | No description |
propertyId | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
spaceId | string | Space ID |
propertyId | string | Deleted property ID |
deleted | boolean | Deletion status |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
spaceId | string | Yes | No description |
limit | number | No | No description |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
permissions | array | Array of space permissions |
↳ id | string | Permission ID |
↳ principalType | string | Principal type (user, group, role) |
↳ principalId | string | Principal ID |
↳ operationKey | string | Operation key (read, create, delete, etc.) |
↳ operationTargetType | string | Target type (page, blogpost, space, etc.) |
↳ anonymousAccess | boolean | Whether anonymous access is allowed |
↳ unlicensedAccess | boolean | Whether unlicensed access is allowed |
spaceId | string | Space ID |
nextCursor | string | Cursor for fetching the next page of results |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | Yes | No description |
limit | number | No | No description |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
descendants | array | Array of descendant pages |
↳ id | string | Page ID |
↳ title | string | Page title |
↳ type | string | Content type (page, whiteboard, database, etc.) |
↳ status | string | Page status |
↳ spaceId | string | Space ID |
↳ parentId | string | Parent page ID |
↳ childPosition | number | Position among siblings |
↳ depth | number | Depth in the hierarchy |
pageId | string | Parent page ID |
nextCursor | string | Cursor for fetching the next page of results |
List inline tasks from Confluence. Optionally filter by page, space, assignee, or status.
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
pageId | string | No | No description |
spaceId | string | No | No description |
assignedTo | string | No | No description |
status | string | No | No description |
limit | number | No | No description |
cursor | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
tasks | array | Array of Confluence tasks |
↳ id | string | Task ID |
↳ localId | string | Local task ID |
↳ spaceId | string | Space ID |
↳ pageId | string | Page ID |
↳ blogPostId | string | Blog post ID |
↳ status | string | Task status (complete or incomplete) |
↳ body | string | Task body content in storage format |
↳ createdBy | string | Creator account ID |
↳ assignedTo | string | Assignee account ID |
↳ completedBy | string | Completer account ID |
↳ createdAt | string | Creation timestamp |
↳ updatedAt | string | Last update timestamp |
↳ dueAt | string | Due date |
↳ completedAt | string | Completion timestamp |
nextCursor | string | Cursor for fetching the next page of results |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
taskId | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
id | string | Task ID |
localId | string | Local task ID |
spaceId | string | Space ID |
pageId | string | Page ID |
blogPostId | string | Blog post ID |
status | string | Task status (complete or incomplete) |
body | string | Task body content in storage format |
createdBy | string | Creator account ID |
assignedTo | string | Assignee account ID |
completedBy | string | Completer account ID |
createdAt | string | Creation timestamp |
updatedAt | string | Last update timestamp |
dueAt | string | Due date |
completedAt | string | Completion timestamp |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
taskId | string | Yes | No description |
status | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
id | string | Task ID |
localId | string | Local task ID |
spaceId | string | Space ID |
pageId | string | Page ID |
blogPostId | string | Blog post ID |
status | string | Updated task status |
body | string | Task body content in storage format |
createdBy | string | Creator account ID |
assignedTo | string | Assignee account ID |
completedBy | string | Completer account ID |
createdAt | string | Creation timestamp |
updatedAt | string | Last update timestamp |
dueAt | string | Due date |
completedAt | string | Completion timestamp |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
blogPostId | string | Yes | No description |
title | string | No | No description |
content | string | No | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
blogPostId | string | Updated blog post ID |
title | string | Blog post title |
status | string | Blog post status |
spaceId | string | Space ID |
version | json | Version information |
url | string | URL to view the blog post |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
blogPostId | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
blogPostId | string | Deleted blog post ID |
deleted | boolean | Deletion status |
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
accountId | string | Yes | No description |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
accountId | string | Atlassian account ID of the user |
displayName | string | Display name of the user |
email | string | Email address of the user |
accountType | string | Account type (e.g., atlassian, app, customer) |
profilePicture | string | Path to the user profile picture |
publicName | string | Public name of the user |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
ts | string | Timestamp |
pageId | string | Page identifier |
content | string | Page content |
body | json | Page body with storage format |
title | string | Page title |
url | string | Page or resource URL |
success | boolean | Operation success status |
deleted | boolean | Deletion status |
added | boolean | Addition status |
removed | boolean | Removal status |
updated | boolean | Update status |
results | array | Search results |
pages | array | List of pages |
children | array | List of child pages |
ancestors | array | List of ancestor pages |
comments | array | List of comments |
commentId | string | Comment identifier |
attachments | array | List of attachments |
attachmentId | string | Attachment identifier |
fileSize | number | Attachment file size in bytes |
mediaType | string | Attachment MIME type |
downloadUrl | string | Attachment download URL |
labels | array | List of labels |
labelName | string | Label name |
labelId | string | Label identifier |
spaces | array | List of spaces |
spaceId | string | Space identifier |
name | string | Space name |
key | string | Space key |
type | string | Space or content type |
status | string | Space status |
blogPosts | array | List of blog posts |
blogPostId | string | Blog post identifier |
versions | array | List of page versions |
version | json | Version information |
versionNumber | number | Version number |
properties | array | List of page properties |
propertyId | string | Property identifier |
propertyKey | string | Property key |
propertyValue | json | Property value |
accountId | string | Atlassian account ID |
displayName | string | User display name |
email | string | User email address |
accountType | string | Account type (atlassian, app, customer) |
profilePicture | string | Path to user profile picture |
publicName | string | User public name |
tasks | array | List of tasks |
taskId | string | Task identifier |
descendants | array | List of descendant pages |
permissions | array | List of space permissions |
homepageId | string | Space homepage ID |
description | json | Space description |
nextCursor | string | Cursor for fetching next page of results |
sourcePageId | string | ID of the source page (copy) |
destinationPageId | string | ID of the destination/copied page |
newPosition | string | New position of moved page |
parentId | string | New parent page ID after move |
total | number | Total number of versions/templates |
templates | array | List of templates |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
ts | string | Timestamp |
pageId | string | Page identifier |
content | string | Page content |
body | json | Page body with storage format |
title | string | Page title |
url | string | Page or resource URL |
success | boolean | Operation success status |
deleted | boolean | Deletion status |
added | boolean | Addition status |
removed | boolean | Removal status |
updated | boolean | Update status |
results | array | Search results |
pages | array | List of pages |
children | array | List of child pages |
ancestors | array | List of ancestor pages |
comments | array | List of comments |
commentId | string | Comment identifier |
attachments | array | List of attachments |
attachmentId | string | Attachment identifier |
fileSize | number | Attachment file size in bytes |
mediaType | string | Attachment MIME type |
downloadUrl | string | Attachment download URL |
labels | array | List of labels |
labelName | string | Label name |
labelId | string | Label identifier |
spaces | array | List of spaces |
spaceId | string | Space identifier |
name | string | Space name |
key | string | Space key |
type | string | Space or content type |
status | string | Space status |
blogPosts | array | List of blog posts |
blogPostId | string | Blog post identifier |
versions | array | List of page versions |
version | json | Version information |
versionNumber | number | Version number |
properties | array | List of page properties |
propertyId | string | Property identifier |
propertyKey | string | Property key |
propertyValue | json | Property value |
accountId | string | Atlassian account ID |
displayName | string | User display name |
email | string | User email address |
accountType | string | Account type (atlassian, app, customer) |
profilePicture | string | Path to user profile picture |
publicName | string | User public name |
tasks | array | List of tasks |
taskId | string | Task identifier |
descendants | array | List of descendant pages |
permissions | array | List of space permissions |
homepageId | string | Space homepage ID |
description | json | Space description |
nextCursor | string | Cursor for fetching next page of results |
sourcePageId | string | ID of the source page (copy) |
destinationPageId | string | ID of the destination/copied page |
newPosition | string | New position of moved page |
parentId | string | New parent page ID after move |
total | number | Total number of versions/templates |
templates | array | List of templates |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
ts | string | Timestamp |
pageId | string | Page identifier |
content | string | Page content |
body | json | Page body with storage format |
title | string | Page title |
url | string | Page or resource URL |
success | boolean | Operation success status |
deleted | boolean | Deletion status |
added | boolean | Addition status |
removed | boolean | Removal status |
updated | boolean | Update status |
results | array | Search results |
pages | array | List of pages |
children | array | List of child pages |
ancestors | array | List of ancestor pages |
comments | array | List of comments |
commentId | string | Comment identifier |
attachments | array | List of attachments |
attachmentId | string | Attachment identifier |
fileSize | number | Attachment file size in bytes |
mediaType | string | Attachment MIME type |
downloadUrl | string | Attachment download URL |
labels | array | List of labels |
labelName | string | Label name |
labelId | string | Label identifier |
spaces | array | List of spaces |
spaceId | string | Space identifier |
name | string | Space name |
key | string | Space key |
type | string | Space or content type |
status | string | Space status |
blogPosts | array | List of blog posts |
blogPostId | string | Blog post identifier |
versions | array | List of page versions |
version | json | Version information |
versionNumber | number | Version number |
properties | array | List of page properties |
propertyId | string | Property identifier |
propertyKey | string | Property key |
propertyValue | json | Property value |
accountId | string | Atlassian account ID |
displayName | string | User display name |
email | string | User email address |
accountType | string | Account type (atlassian, app, customer) |
profilePicture | string | Path to user profile picture |
publicName | string | User public name |
tasks | array | List of tasks |
taskId | string | Task identifier |
descendants | array | List of descendant pages |
permissions | array | List of space permissions |
homepageId | string | Space homepage ID |
description | json | Space description |
nextCursor | string | Cursor for fetching next page of results |
sourcePageId | string | ID of the source page (copy) |
destinationPageId | string | ID of the destination/copied page |
newPosition | string | New position of moved page |
parentId | string | New parent page ID after move |
total | number | Total number of versions/templates |
templates | array | List of templates |
Search Confluence content using CQL (Confluence Query Language).
| Parameter | Type | Required | Description |
|---|
domain | string | Yes | No description |
cql | string | Yes | CQL query string (e.g., "type=page and text~"search term" and space=KEY") |
limit | number | No | Maximum number of results to return (default: 25, max: 100) |
cursor | string | No | Cursor for pagination |
cloudId | string | No | Confluence Cloud ID for the instance. If not provided, fetched using domain. |
| Parameter | Type | Description |
|---|
ts | string | ISO 8601 timestamp of the operation |
results | array | Array of search results |
↳ id | string | Content ID |
↳ title | string | Content title |
↳ type | string | Content type (e.g., page, blogpost, attachment) |
↳ status | string | Content status |
↳ url | string | URL to view the content |
↳ excerpt | string | Text excerpt matching the query |
↳ spaceKey | string | Space key containing the content |
↳ lastModified | string | Last modified timestamp |
nextCursor | string | Cursor for fetching the next page of results |
total | number | Total number of matching results |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
ts | string | Timestamp |
pageId | string | Page identifier |
content | string | Page content |
body | json | Page body with storage format |
title | string | Page title |
url | string | Page or resource URL |
success | boolean | Operation success status |
deleted | boolean | Deletion status |
added | boolean | Addition status |
removed | boolean | Removal status |
updated | boolean | Update status |
results | array | Search results |
pages | array | List of pages |
children | array | List of child pages |
ancestors | array | List of ancestor pages |
comments | array | List of comments |
commentId | string | Comment identifier |
attachments | array | List of attachments |
attachmentId | string | Attachment identifier |
fileSize | number | Attachment file size in bytes |
mediaType | string | Attachment MIME type |
downloadUrl | string | Attachment download URL |
labels | array | List of labels |
labelName | string | Label name |
labelId | string | Label identifier |
spaces | array | List of spaces |
spaceId | string | Space identifier |
name | string | Space name |
key | string | Space key |
type | string | Space or content type |
status | string | Space status |
blogPosts | array | List of blog posts |
blogPostId | string | Blog post identifier |
versions | array | List of page versions |
version | json | Version information |
versionNumber | number | Version number |
properties | array | List of page properties |
propertyId | string | Property identifier |
propertyKey | string | Property key |
propertyValue | json | Property value |
accountId | string | Atlassian account ID |
displayName | string | User display name |
email | string | User email address |
accountType | string | Account type (atlassian, app, customer) |
profilePicture | string | Path to user profile picture |
publicName | string | User public name |
tasks | array | List of tasks |
taskId | string | Task identifier |
descendants | array | List of descendant pages |
permissions | array | List of space permissions |
homepageId | string | Space homepage ID |
description | json | Space description |
nextCursor | string | Cursor for fetching next page of results |
sourcePageId | string | ID of the source page (copy) |
destinationPageId | string | ID of the destination/copied page |
newPosition | string | New position of moved page |
parentId | string | New parent page ID after move |
total | number | Total number of versions/templates |
templates | array | List of templates |