confluence

Access Confluence pages, spaces, and search results via REST API.

6|2|Updated Jul 8, 2012

Search Tags:#api #rest #search #confluence #pages #spaces

Ready to run

npx skills add https://github.com/athal7/dotfiles --skill confluence-athal7

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: confluence
Source: https://github.com/athal7/dotfiles/tree/main/skills/confluence
Command: npx skills add https://github.com/athal7/dotfiles --skill confluence-athal7

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Access to Confluence content and metadata through the REST API for automation, data gathering, and integration with external tooling.

Core Features & Use Cases

Retrieve wiki pages, spaces, and attachments via v2 endpoints
Perform CQL-like searches and legacy v1 lookups for labels and content
Handle pagination and versioning when updating pages or querying content

Quick Start

Use the Confluence REST API to fetch a page titled "Home" from the "DEMO" space.

Frequently Asked Questions about confluence

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I retrieve Confluence pages and spaces using the REST API?▼

You can retrieve Confluence pages and spaces by making requests to the v2 REST API endpoints, which support fetching content and metadata across large workspaces with proper pagination. Legacy v1 endpoints are also available for older lookups.

What is the best way to search Confluence content programmatically?▼

The best way to search Confluence content programmatically is by using CQL search endpoints provided by the REST API. This allows you to perform targeted queries to find specific pages, labels, and attachments across your workspaces.

How do I handle versioning when updating Confluence pages via the API?▼

When updating Confluence pages via the API, you must handle versioning by tracking the current version number and incrementing it in your update payload. The API provides guidance on managing versions to prevent conflicting overwrites.

Can I use both v1 and v2 Confluence REST API endpoints for automation?▼

Yes, you can use both v1 and v2 Confluence REST API endpoints for automation. The v2 endpoints handle pages, spaces, and attachments, while legacy v1 endpoints are supported for looking up labels and older content structures.

Does the Confluence REST API support pagination for large workspaces?▼

Yes, the Confluence REST API supports proper pagination for retrieving pages, spaces, and search results across large workspaces. This ensures automated data gathering processes can handle extensive content sets without timing out.

Why use CQL search instead of standard queries when fetching Confluence attachments?▼

Using CQL search instead of standard queries allows for more complex, structured filtering when fetching Confluence attachments and content. CQL endpoints enable targeted lookups across spaces and labels that basic API requests cannot easily replicate.