Confluence

Confluence Relation API

The Relation API from Confluence — 3 operation(s) for relation.

GitHub OpenAPI

Operations 5

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/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType} Find what an entity is related to · Find target entities related to a source entity #
Ask an LLM
“How do I list all the pages a user has marked as favourite?”
“Which content does a given user have an 'ignore' relationship with?”
Tell an agent
Find all {targetType} that {sourceType} {sourceKey} has a {relationName} relationship to.
List the {targetType} items user {sourceKey} marked as {relationName}, source type {sourceType}.
GET /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey} Check if a relationship exists between two entities · Find relationship from source to target #
Ask an LLM
“Has a user favourited a specific page?”
“Can I check whether one particular relationship exists from a source to a target?”
Tell an agent
Check whether {sourceType} {sourceKey} has a {relationName} relationship to {targetType} {targetKey}.
Tell me if {sourceType} {sourceKey} has favourited {targetType} {targetKey} via relation {relationName}.
PUT /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey} Create a relationship such as a favourite · Create relationship #
Ask an LLM
“How do I mark a page as a favourite for a user through the API?”
“Can I define my own custom relationship type between a user and a space?”
Tell an agent
Create a {relationName} relationship from {sourceType} {sourceKey} to {targetType} {targetKey}.
Favourite {targetType} {targetKey} for {sourceType} {sourceKey} using relation {relationName}.
DELETE /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey} Remove a relationship between two entities · Delete relationship #
Ask an LLM
“How do I unfavourite a page for a user?”
“Can I delete a custom relationship between a user and content?”
Tell an agent destructive · confirm first
Delete the {relationName} relationship from {sourceType} {sourceKey} to {targetType} {targetKey}.
Unfavourite {targetType} {targetKey} for {sourceType} {sourceKey}, relation {relationName}.
GET /wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType} Find who is related to a target entity · Find source entities related to a target entity #
Ask an LLM
“Which users have a 'collaborator' relationship to a page?”
“Who has favourited a particular piece of content?”
Tell an agent
Find all {sourceType} with a {relationName} relationship to {targetType} {targetKey}.
List the {sourceType} who marked {targetType} {targetKey} as {relationName}.

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://artifacts.apis.io/confluence/openapi/confluence-relation-api-openapi.yml

Other Resources

🔗
Postman
https://developer.atlassian.com/cloud/confluence/confcloud.2.postman.json
🔗
PostmanCollection
https://artifacts.apis.io/confluence/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-relation-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-relation-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluence Cloud REST Relation 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 (82 KB total) ---
# Full source: https://artifacts.apis.io/confluence/openapi/confluence-relation-api-openapi.yml