Confluence client handle + the request seam every atlassian.confluence.*
endpoint namespace is built on.
Confluence Cloud exposes two REST surfaces on the same site, both authed with the same API token as Jira (Basic email:token):
:v2 (default) -> /wiki/api/v2 modern, cursor-paginated, recommended :v1 -> /wiki/rest/api legacy, still supported, has CQL search etc.
Endpoint namespaces are split by version (atlassian.confluence.v2.* and
atlassian.confluence.v1.*) and never build URLs themselves — they call
request with a path RELATIVE to the chosen API root:
(require '[atlassian.confluence.client :as confluence]) (def c (confluence/client)) (confluence/request c {:method :get :path "/pages" :query {:limit 25}}) ; v2 (confluence/request c {:api :v1 :method :get :path "/search" :query {:cql "type=page"}})
Pagination: v2 returns {:results [...] :_links {:next "/wiki/api/v2/...?cursor=..."}}.
Pass the cursor query param from the next link to page; next-cursor extracts it.
Confluence client handle + the `request` seam every atlassian.confluence.*
endpoint namespace is built on.
Confluence Cloud exposes two REST surfaces on the same site, both authed with
the same API token as Jira (Basic email:token):
:v2 (default) -> /wiki/api/v2 modern, cursor-paginated, recommended
:v1 -> /wiki/rest/api legacy, still supported, has CQL search etc.
Endpoint namespaces are split by version (atlassian.confluence.v2.* and
atlassian.confluence.v1.*) and never build URLs themselves — they call
`request` with a path RELATIVE to the chosen API root:
(require '[atlassian.confluence.client :as confluence])
(def c (confluence/client))
(confluence/request c {:method :get :path "/pages" :query {:limit 25}}) ; v2
(confluence/request c {:api :v1 :method :get :path "/search" :query {:cql "type=page"}})
Pagination: v2 returns `{:results [...] :_links {:next "/wiki/api/v2/...?cursor=..."}}`.
Pass the `cursor` query param from the next link to page; `next-cursor` extracts it.Confluence v1 admin endpoints: analytics, audit, long-running tasks, relations, settings (look-and-feel, themes), space labels/themes, and templates.
Confluence v1 admin endpoints: analytics, audit, long-running tasks, relations, settings (look-and-feel, themes), space labels/themes, and templates.
Confluence v1 Content API — archive, blueprint, search, macro, permissions, versions, and body conversion.
Confluence v1 Content API — archive, blueprint, search, macro, permissions, versions, and body conversion.
Confluence v1 content-children / descendants / attachment operations.
All fns delegate to atlassian.confluence.client/request with :api :v1.
Confluence v1 content-children / descendants / attachment operations. All fns delegate to `atlassian.confluence.client/request` with :api :v1.
Confluence Cloud v1 Content Restrictions API.
Manage read/update restrictions on content by operation, group, and user.
All list endpoints accept an optional expand query param.
Confluence Cloud v1 Content Restrictions API. Manage read/update restrictions on content by operation, group, and user. All list endpoints accept an optional `expand` query param.
Confluence v1 Content States API endpoint functions.
Confluence v1 Content States API endpoint functions.
Confluence v1 Content Watches API — watch status and watcher management for pages, spaces, labels, and content.
Confluence v1 Content Watches API — watch status and watcher management for pages, spaces, labels, and content.
Confluence v1 label endpoints: add/remove content labels, query label info.
Confluence v1 label endpoints: add/remove content labels, query label info.
Confluence v1 Search API — CQL-based search for content and users.
Confluence v1 Search API — CQL-based search for content and users.
Confluence v1 Spaces API — create, update, delete spaces and manage space permissions/settings.
Confluence v1 Spaces API — create, update, delete spaces and manage space permissions/settings.
Confluence v1 Users and Groups API — groups, group members, users, and user properties.
Confluence v1 Users and Groups API — groups, group members, users, and user properties.
Confluence v2 Attachment endpoints.
Confluence v2 Attachment endpoints.
Confluence v2 blog-post endpoints.
Confluence v2 blog-post endpoints.
Classification level operations for Confluence Cloud v2.
Classification level operations for Confluence Cloud v2.
Confluence Cloud v2 Comments API — footer and inline comments.
Cursor-paginated list endpoints return {:results [...] :_links {:next ...}}.
Page with the cursor query param; use atlassian.confluence.client/next-cursor
to extract the cursor from a response.
Comment bodies use storage representation: {:body {:representation "storage" :value "<p>Hello</p>"}}
Confluence Cloud v2 Comments API — footer and inline comments.
Cursor-paginated list endpoints return {:results [...] :_links {:next ...}}.
Page with the `cursor` query param; use `atlassian.confluence.client/next-cursor`
to extract the cursor from a response.
Comment bodies use storage representation:
{:body {:representation "storage" :value "<p>Hello</p>"}}Confluence Cloud v2 Content Properties API.
Cursor-paginated list responses include :results and :_links {:next ...};
page with the cursor query param.
Confluence Cloud v2 Content Properties API.
Cursor-paginated list responses include :results and :_links {:next ...};
page with the `cursor` query param.Confluence v2 Custom Content endpoint fns — one per operationId in v2-custom-content.edn.
Confluence v2 Custom Content endpoint fns — one per operationId in v2-custom-content.edn.
Confluence v2 hierarchy endpoints: ancestors, descendants, children, and direct-children for pages, databases, folders, whiteboards, smart links, and custom content.
All list responses are cursor-paginated: {:results [...] :_links {:next ...}}.
Page with the cursor query param; use atlassian.confluence.client/next-cursor
to extract it from a response.
Confluence v2 hierarchy endpoints: ancestors, descendants, children, and
direct-children for pages, databases, folders, whiteboards, smart links,
and custom content.
All list responses are cursor-paginated: {:results [...] :_links {:next ...}}.
Page with the `cursor` query param; use `atlassian.confluence.client/next-cursor`
to extract it from a response.Confluence v2 Label endpoint fns — one per operationId in v2-labels.edn.
Confluence v2 Label endpoint fns — one per operationId in v2-labels.edn.
Miscellaneous Confluence v2 endpoints: admin key, likes, operations, redactions, tasks, user access, and bulk user lookup.
Miscellaneous Confluence v2 endpoints: admin key, likes, operations, redactions, tasks, user access, and bulk user lookup.
Confluence Cloud v2 Pages API.
Cursor-paginated list endpoints return {:results [...] :_links {:next ...}}.
Page with the cursor query param; use atlassian.confluence.client/next-cursor
to extract the cursor from a response.
Page/blogpost bodies use storage representation: {:body {:representation "storage" :value "<p>Hello</p>"}}
Confluence Cloud v2 Pages API.
Cursor-paginated list endpoints return {:results [...] :_links {:next ...}}.
Page with the `cursor` query param; use `atlassian.confluence.client/next-cursor`
to extract the cursor from a response.
Page/blogpost bodies use storage representation:
{:body {:representation "storage" :value "<p>Hello</p>"}}Confluence v2 Space endpoint fns — one per operationId in v2-spaces.edn.
Confluence v2 Space endpoint fns — one per operationId in v2-spaces.edn.
Confluence v2 Version endpoints — one fn per operation.
Confluence v2 Version endpoints — one fn per operation.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |