Confluence

Confluence Content states API

The Content states API from Confluence — 6 operation(s) for content states.

GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /wiki/rest/api/content/{id}/state Get the status label set on a page · Get content state #
Ask an LLM
“What content state, like 'In progress' or 'Ready for review', is set on a page?”
“Can I see the state on the draft version rather than the published one?”
Tell an agent
Show the content state of page {id}.
Get the content state on the {status} version of content {id}.
PUT /wiki/rest/api/content/{id}/state Set a content state on a page · Set the content state of a content and publishes a new version of the content #
Ask an LLM
“How do I mark a page as 'Ready for review' through the API?”
“Can I create a new custom state by giving a name and color when setting it?”
Tell an agent
Set content state {name} with color {color} on the {status} version of content {id}.
Apply existing state {stateId} to content {id} at status {status}.
DELETE /wiki/rest/api/content/{id}/state Clear the content state from a page · Removes the content state of a content and publishes a new version #
Ask an LLM
“How do I remove the status label from a page?”
“Does clearing a page's content state publish a new version?”
Tell an agent destructive · confirm first
Remove the content state from content {id}.
Clear the state on the {status} version of content {id}.
GET /wiki/rest/api/content/{id}/state/available List the states a page can be set to · Gets available content states for content #
Ask an LLM
“Which content states can I choose from for this page?”
“Why do only three of my custom states show up as options for a page?”
Tell an agent
List the content states available for content {id}.
Show which statuses I could assign to page {id}.
GET /wiki/rest/api/content-states List my custom content states · Get Custom Content States #
Ask an LLM
“What custom content states have I created?”
“Can I see every personal status label I've defined, not just the recent three?”
Tell an agent
List all the custom content states I've created.
Show my personal content state definitions.
GET /wiki/rest/api/space/{spaceKey}/state List a space's suggested content states · Get space suggested content states #
Ask an LLM
“Which content states does a space suggest to its authors?”
“What status labels are defined at the space level?”
Tell an agent
List the suggested content states for space {spaceKey}.
Show the space-defined statuses in {spaceKey}.
GET /wiki/rest/api/space/{spaceKey}/state/settings Get a space's content state settings · Get content state settings for space #
Ask an LLM
“Are content states turned on at all in a given space?”
“Is a space restricting custom content states to its own list?”
Tell an agent
Get the content state settings for space {spaceKey}.
Check whether custom states are allowed in space {spaceKey}.
GET /wiki/rest/api/space/{spaceKey}/state/content Find content in a space with a given state · Get content in space with given content state #
Ask an LLM
“Which pages in a space are currently marked with a particular state?”
“Is the result limit capped when I expand export or styled views?”
Tell an agent
List content in space {spaceKey} with state {state-id}.
Find up to {limit} pages in {spaceKey} marked with state {state-id}.

Documentation

📖
APIReference
https://developer.atlassian.com/cloud/confluence/rest/v2/intro/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v2/intro/
📖
Authentication
https://developer.atlassian.com/cloud/confluence/security-overview/
📖
GettingStarted
https://developer.atlassian.com/cloud/confluence/getting-started/
📖
APIReference
https://developer.atlassian.com/cloud/confluence/rest/v1/intro/
📖
Documentation
https://developer.atlassian.com/cloud/confluence/rest/v1/intro/
📖
Authentication
https://developer.atlassian.com/cloud/confluence/basic-auth-for-rest-apis/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/confluence/refs/heads/main/openapi/confluence-content-states-api-openapi.yml

Other Resources

🔗
Postman
https://developer.atlassian.com/cloud/confluence/confcloud.2.postman.json
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/confluence/refs/heads/main/collections/confluence-confcloud-v2.postman_collection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/confluence:confluence-content-states-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

confluence-content-states-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluence Cloud REST Content states API
  description: This document describes the REST API and resources provided by Confluence.
  termsOfService: https://atlassian.com/terms/
  version: 1.0.0
servers:
- url: //your-domain.atlassian.net
tags:


# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/confluence/refs/heads/main/openapi/confluence-content-states-api-openapi.yml