### Get Ancestors of Smart Link (Python)

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-ancestors

Python example to get ancestors of a Smart Link. Ensure the Confluence client is properly initialized.

```python
response = client.get("/wiki/api/v2/embeds/{id}/ancestors", {
    "headers": {
        "Accept": "application/json"
    }
})
print(response.status_code)
print(response.json())

```

--------------------------------

### Example JSON response for GET /tasks

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-task

Illustrates the structure of a successful JSON response when retrieving a list of tasks.

```json
{
  "results": [
    {
      "id": "<string>",
      "localId": "<string>",
      "spaceId": "<string>",
      "pageId": "<string>",
      "blogPostId": "<string>",
      "status": "complete",
      "body": {
        "storage": {},
        "atlas_doc_format": {}
      },
      "createdBy": "<string>",
      "assignedTo": "<string>",
      "completedBy": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "dueAt": "<string>",
      "completedAt": "<string>"
    }
  ],
  "_links": {
    "next": "<string>",
    "base": "<string>"
  }
}
```

--------------------------------

### Get Admin Key Response Example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-admin-key

This is an example of a successful JSON response when an admin key is enabled. It includes the account ID and the expiration time of the key.

```json
{ "accountId": "<string>", "expirationTime": "<string>" }
```

--------------------------------

### Example Response for Get Space Role Assignments

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles

Illustrates the structure of a successful response when retrieving space role assignments.

```json
{ "results": [ { "principal": { "principalType": "USER", "principalId": "<string>" }, "roleId": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
```

--------------------------------

### Smart Link Response Example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link

Example JSON response when a Smart Link is successfully created.

```json
{ "id": "<string>", "type": "<string>", "status": "current", "title": "<string>", "parentId": "<string>", "parentType": "page", "position": 61, "authorId": "<string>", "ownerId": "<string>", "createdAt": "<string>", "embedUrl": "<string>", "spaceId": "<string>", "version": { "createdAt": "<string>", "message": "<string>", "number": 19, "minorEdit": true, "authorId": "<string>" }, "_links": { "base": "<string>" } }
```

--------------------------------

### Get Pages for Label Response Example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page

Example JSON response structure for retrieving pages associated with a label. This includes a list of page results and links for pagination.

```json
{
  "results": [
    {
      "id": "<string>",
      "status": "current",
      "title": "<string>",
      "spaceId": "<string>",
      "parentId": "<string>",
      "parentType": "page",
      "position": 57,
      "authorId": "<string>",
      "ownerId": "<string>",
      "lastOwnerId": "<string>",
      "subtype": "<string>",
      "createdAt": "<string>",
      "version": {
        "createdAt": "<string>",
        "message": "<string>",
        "number": 19,
        "minorEdit": true,
        "authorId": "<string>"
      },
      "body": {
        "storage": {},
        "atlas_doc_format": {}
      },
      "_links": {
        "webui": "<string>",
        "editui": "<string>",
        "tinyui": "<string>"
      }
    }
  ],
  "_links": {
    "next": "<string>",
    "base": "<string>"
  }
}
```

--------------------------------

### Example Response for Get Content Properties

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties

An example JSON response structure for retrieving content properties of a comment.

```json
{
  "results": [
    {
      "id": "<string>",
      "key": "<string>",
      "version": {
        "createdAt": "<string>",
        "message": "<string>",
        "number": 19,
        "minorEdit": true,
        "authorId": "<string>"
      }
    }
  ],
  "_links": {
    "next": "<string>",
    "base": "<string>"
  }
}
```

--------------------------------

### Example JSON response for spaces with data policies

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-data-policies

This is an example of the JSON structure returned by the GET /data-policies/spaces endpoint, showing a list of spaces with their data policy information.

```json
{ "results": [ { "id": "<string>", "key": "<string>", "name": "<string>", "description": { "plain": {}, "view": {} }, "dataPolicy": { "anyContentBlocked": true }, "icon": { "path": "<string>", "apiDownloadLink": "<string>" }, "_links": { "webui": "<string>" } } ], "_links": { "next": "<string>", "base": "<string>" } }
```

--------------------------------

### Get Ancestors of Smart Link (Java)

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-ancestors

Java example for fetching Smart Link ancestors. This requires setting up the Confluence client and making the appropriate API call.

```java
Response<EmbedsAncestors> response = client.getEmbeds().getAncestors("{id}");
System.out.println(response.getStatus());
System.out.println(response.getPayload());
```

--------------------------------

### Blog Post Content Properties Response Example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties

Example JSON structure for a successful response when retrieving content properties for a blog post.

```json
{ "results": [ { "id": "<string>", "key": "<string>", "version": { "createdAt": "<string>", "message": "<string>", "number": 19, "minorEdit": true, "authorId": "<string>" } } ], "_links": { "next": "<string>", "base": "<string>" } }
```

--------------------------------

### Paginated Request Example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/intro/#about

Example of a GET request to retrieve a limited number of page objects.

```APIDOC
## GET /wiki/api/v2/pages?limit=5

### Description
This endpoint retrieves a limited number of page objects. The `limit` parameter specifies the maximum number of objects to return in a single response.

### Method
GET

### Endpoint
/wiki/api/v2/pages

### Query Parameters
- **limit** (integer) - Optional - The maximum number of objects to return per page.
- **cursor** (string) - Optional - A token that indicates the starting point for retrieving the next set of results.
```

--------------------------------

### Confluence Folder Object Example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder

This is an example of the JSON response structure for a single folder, including its properties and metadata.

```json
{ "id": "<string>", "type": "<string>", "status": "current", "title": "<string>", "parentId": "<string>", "parentType": "page", "position": 57, "authorId": "<string>", "ownerId": "<string>", "createdAt": "<string>", "spaceId": "<string>", "version": { "createdAt": "<string>", "message": "<string>", "number": 19, "minorEdit": true, "authorId": "<string>" }, "_links": { "base": "<string>" } }
```

--------------------------------

### Example Response for Available Space Permissions

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permissions

This is an example of the JSON response structure when successfully retrieving available space permissions. It includes a list of permission results and links for pagination.

```json
{ "results": [ { "id": "<string>", "displayName": "<string>", "description": "<string>", "requiredPermissionIds": [ "<string>" ] } ], "_links": { "next": "<string>", "base": "<string>" } }
```

--------------------------------

### Example Response for Child Pages

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children

This is an example of a successful JSON response when retrieving child pages. It includes a list of child pages and links for pagination.

```json
{ "results": [ { "id": "<string>", "status": "current", "title": "<string>", "spaceId": "<string>", "childPosition": 57 } ], "_links": { "next": "<string>", "base": "<string>" } }
```

--------------------------------

### Get Ancestors of Smart Link (PHP)

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-ancestors

PHP example for retrieving Smart Link ancestors. This snippet demonstrates the basic API call structure.

```php
$response = $client->get("/wiki/api/v2/embeds/{id}/ancestors", [
    'headers' => [
        'Accept' => 'application/json'
    ]
]);
echo $response->status();
echo $response->json();

```

--------------------------------

### Example Ancestor Response

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-ancestors

This is an example of a successful JSON response when retrieving database ancestors. The 'results' array contains minimal information about each ancestor.

```json
{ "results": [ { "id": "<string>", "type": "page" } ] }
```

--------------------------------

### Example JSON response for blog posts

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post

This is an example of the JSON response structure when successfully fetching blog posts by label. It includes a list of blog post results and links for pagination.

```json
{
  "results": [
    {
      "id": "<string>",
      "status": "current",
      "title": "<string>",
      "spaceId": "<string>",
      "authorId": "<string>",
      "createdAt": "<string>",
      "version": {
        "createdAt": "<string>",
        "message": "<string>",
        "number": 19,
        "minorEdit": true,
        "authorId": "<string>"
      },
      "body": {
        "storage": {},
        "atlas_doc_format": {}
      },
      "_links": {
        "webui": "<string>",
        "editui": "<string>",
        "tinyui": "<string>"
      }
    }
  ],
  "_links": {
    "next": "<string>",
    "base": "<string>"
  }
}
```

--------------------------------

### Get Ancestors of Smart Link (Curl)

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-ancestors

Example using curl to fetch ancestors of a Smart Link. Replace `{id}` with the actual Smart Link ID.

```bash
curl - GET "/wiki/api/v2/embeds/{id}/ancestors"
```

--------------------------------

### Pagination Link Header Example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/intro/#about

Example of the 'Link' header returned in a paginated response, indicating the URL for the next set of results.

```APIDOC
## Link Header

### Description
When a response contains paginated results, the `Link` header may include a `rel="next"` relation. This URL allows you to fetch the subsequent page of results.

### Example
```
</wiki/api/v2/pages?limit=5&cursor=<cursor token>>; rel="next"
```

### Response Body Link
Paginated responses may also include a `_links.next` property containing the relative URL for the next set of results.
```

--------------------------------

### Get Ancestors of Smart Link (Node.js)

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-ancestors

Node.js example for retrieving Smart Link ancestors. This snippet assumes you have a configured Confluence client.

```javascript
const response = await api.asApp().requestConfluence(`/wiki/api/v2/embeds/{id}/ancestors`, {
  headers: {
    'Accept': 'application/json'
  }
});
console.log(response.status);
console.log(await response.json());
```

--------------------------------

### Example 200 OK Response for Attachment Properties

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties

This is an example of a successful response when retrieving content properties for an attachment. It includes a list of properties and pagination links.

```json
{ 
  "results": [ 
    { 
      "id": "<string>", 
      "key": "<string>", 
      "version": { 
        "createdAt": "<string>", 
        "message": "<string>", 
        "number": 19, 
        "minorEdit": true, 
        "authorId": "<string>" 
      } 
    } 
  ], 
  "_links": { 
    "next": "<string>", 
    "base": "<string>" 
  } 
}
```

--------------------------------

### Example Whiteboard JSON Response

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard

This is an example of the JSON response structure when successfully retrieving a whiteboard. It includes details like ID, title, author, and version information.

```json
{ "id": "<string>", "type": "<string>", "status": "current", "title": "<string>", "parentId": "<string>", "parentType": "page", "position": 61, "authorId": "<string>", "ownerId": "<string>", "createdAt": "<string>", "spaceId": "<string>", "version": { "createdAt": "<string>", "message": "<string>", "number": 19, "minorEdit": true, "authorId": "<string>" }, "_links": { "base": "<string>" } }
```

--------------------------------

### Data Policy Metadata Response Example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-data-policies

Example JSON response for data policy metadata, indicating if any content is blocked.

```JSON
{ "anyContentBlocked": true }
```

--------------------------------

### Space permission assignment response example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permissions

This is an example of the JSON response structure for space permission assignments, detailing principals and operations.

```json
{ "results": [ { "id": "<string>", "principal": { "type": "user", "id": "<string>" }, "operation": { "key": "use", "targetType": "page" } } ], "_links": { "next": "<string>", "base": "<string>" } }
```

--------------------------------

### Attachment Versions Response Example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version

This is an example of a successful JSON response when retrieving attachment versions. It includes a list of versions with their details and pagination links.

```json
{ "results": [ { "createdAt": "<string>", "message": "<string>", "number": 19, "minorEdit": true, "authorId": "<string>", "attachment": { "title": "<string>", "id": "<string>", "body": {} } } ], "_links": { "next": "<string>", "base": "<string>" } }
```

--------------------------------

### Example response for smart link descendants

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants

This is an example of the JSON response structure when fetching descendants of a smart link. It includes a list of results with basic information and pagination links.

```json
{ "results": [ { "id": "<string>", "status": "current", "title": "<string>", "type": "<string>", "parentId": "<string>", "depth": 93, "childPosition": 238 } ], "_links": { "next": "<string>", "base": "<string>" } }
```

--------------------------------

### Example 200 OK Response for child custom content

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children

This is an example of a successful response when retrieving child custom content. It includes a list of results and pagination links.

```json
{ "results": [ { "id": "<string>", "status": "current", "title": "<string>", "type": "<string>", "spaceId": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
```

--------------------------------

### Example JSON response for a task

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-task

This is an example of the JSON structure returned when a task is successfully retrieved. It includes details like ID, status, body content, and timestamps.

```json
{ "id": "<string>", "localId": "<string>", "spaceId": "<string>", "pageId": "<string>", "blogPostId": "<string>", "status": "complete", "body": { "storage": { "representation": "<string>", "value": "<string>" }, "atlas_doc_format": { "representation": "<string>", "value": "<string>" } }, "createdBy": "<string>", "assignedTo": "<string>", "completedBy": "<string>", "createdAt": "<string>", "updatedAt": "<string>", "dueAt": "<string>", "completedAt": "<string>" }
```

--------------------------------

### Smart Link permitted operations response example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-operation

This is an example of the JSON response when retrieving permitted operations for a Smart Link. It lists the operations and their target types.

```JSON
{ "operations": [ { "operation": "<string>", "targetType": "<string>" } ] }
```

--------------------------------

### Example JSON Response for Footer Comments

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment

This is an example of the JSON response structure when successfully retrieving footer comments for a blog post. It includes a list of comments and links for pagination.

```json
{
  "results": [
    {
      "id": "<string>",
      "status": "current",
      "title": "<string>",
      "blogPostId": "<string>",
      "version": {
        "createdAt": "<string>",
        "message": "<string>",
        "number": 19,
        "minorEdit": true,
        "authorId": "<string>"
      },
      "body": {
        "storage": {},
        "atlas_doc_format": {}
      },
      "_links": {
        "webui": "<string>"
      }
    }
  ],
  "_links": {
    "next": "<string>",
    "base": "<string>"
  }
}
```

--------------------------------

### Example JSON response for custom content comments

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment

This is an example of the JSON structure returned when successfully retrieving custom content comments. It includes a list of comments and links for pagination.

```json
{ "results": [ { "id": "<string>", "status": "current", "title": "<string>", "customContentId": "<string>", "version": { "createdAt": "<string>", "message": "<string>", "number": 19, "minorEdit": true, "authorId": "<string>" }, "body": { "storage": {}, "atlas_doc_format": {}, "view": {} }, "_links": { "webui": "<string>" } } ], "_links": { "next": "<string>", "base": "<string>" } }
```

--------------------------------

### Example Response for Created Footer Comment

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment

This is an example of a successful response when a footer comment is created. It includes details of the created comment, its version, properties, operations, likes, and links.

```json
{ "id": "<string>", "status": "current", "title": "<string>", "blogPostId": "<string>", "pageId": "<string>", "attachmentId": "<string>", "customContentId": "<string>", "parentCommentId": "<string>", "version": { "createdAt": "<string>", "message": "<string>", "number": 19, "minorEdit": true, "authorId": "<string>" }, "properties": { "results": [ { "id": "<string>", "key": "<string>", "version": {} } ], "meta": { "hasMore": true, "cursor": "<string>" }, "_links": { "self": "<string>" } }, "operations": { "results": [ { "operation": "<string>", "targetType": "<string>" } ], "meta": { "hasMore": true, "cursor": "<string>" }, "_links": { "self": "<string>" } }, "likes": { "results": [ { "accountId": "<string>" } ], "meta": { "hasMore": true, "cursor": "<string>" }, "_links": { "self": "<string>" } }, "versions": { "results": [ { "createdAt": "<string>", "message": "<string>", "number": 19, "minorEdit": true, "authorId": "<string>" } ], "meta": { "hasMore": true, "cursor": "<string>" }, "_links": { "self": "<string>" } }, "body": { "storage": {}, "atlas_doc_format": {}, "view": {} }, "_links": { "base": "<string>" } }
```

--------------------------------

### Example Classification Levels Response

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level

An example of the JSON response when successfully retrieving a list of classification levels. Each level includes its ID, status, order, name, description, guideline, and color.

```json
[ {
  "id": "<string>",
  "status": "DRAFT",
  "order": 45,
  "name": "<string>",
  "description": "<string>",
  "guideline": "<string>",
  "color": "RED"
} ]
```

--------------------------------

### Example Response for Get Children Footer Comments

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment

An example JSON response structure for retrieving children footer comments, including results and pagination links.

```json
{
  "results": [
    {
      "id": "<string>",
      "status": "current",
      "title": "<string>",
      "parentCommentId": "<string>",
      "version": {
        "createdAt": "<string>",
        "message": "<string>",
        "number": 19,
        "minorEdit": true,
        "authorId": "<string>"
      },
      "body": {
        "storage": {},
        "atlas_doc_format": {}
      },
      "_links": {
        "webui": "<string>"
      }
    }
  ],
  "_links": {
    "next": "<string>",
    "base": "<string>"
  }
}
```

--------------------------------

### Create Database Response

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database

Example JSON response for a successfully created database. Includes the database ID, type, status, title, parent information, creation timestamps, author and owner IDs, space ID, and version details.

```json
{ "id": "<string>", "type": "<string>", "status": "current", "title": "<string>", "parentId": "<string>", "parentType": "page", "position": 59, "authorId": "<string>", "ownerId": "<string>", "createdAt": "<string>", "spaceId": "<string>", "version": { "createdAt": "<string>", "message": "<string>", "number": 19, "minorEdit": true, "authorId": "<string>" }, "_links": { "base": "<string>" } }
```

--------------------------------

### Create Blog Post using Forge

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post

Use this Forge sample to create a blog post. Ensure you have the necessary OAuth 2.0 or Connect app scopes.

```javascript
// This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import { requestConfluence } from "@forge/bridge"; var bodyData = `{   "spaceId": "<string>",   "status": "current",   "title": "<string>",   "body": {     "representation": "storage",     "value": "<string>"   },   "createdAt": "<string>" }`; const response = await requestConfluence(`/wiki/api/v2/blogposts`, {   method: 'POST',   headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' },   body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
```

--------------------------------

### Example Response for Available Space Roles

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles

Illustrates the structure of a successful JSON response when retrieving available space roles. It includes a list of roles, each with an ID, type, name, description, and associated space permissions.

```json
{ "results": [ { "id": "<string>", "type": "SYSTEM", "name": "<string>", "description": "<string>", "spacePermissions": [ "<string>" ] } ], "_links": { "next": "<string>", "base": "<string>" } }
```

--------------------------------

### Get blog post classification level using Node.js

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level

Example of retrieving a blog post's classification level in Node.js. This requires setting up an HTTP client to make the GET request.

```javascript
const axios = require('axios');

async function getClassificationLevel(id) {
  const url = `https://your-domain.atlassian.net/wiki/api/v2/blogposts/${id}/classification-level`;
  try {
    const response = await axios.get(url, {
      headers: {
        'Accept': 'application/json'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error fetching classification level:', error);
    throw error;
  }
}

// Example usage:
// getClassificationLevel('<blog-post-id>')
//  .then(data => console.log(data))
//  .catch(err => console.error(err));
```

--------------------------------

### Get direct children of a whiteboard (Node.js)

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-children

This Node.js example shows how to call the Confluence REST API v2 to get direct children of a whiteboard. It uses the 'axios' library for making HTTP requests. Ensure you have the 'read:hierarchical-content:confluence' scope.

```javascript
const axios = require('axios');

const getWhiteboardChildren = async (id) => {
  const url = `https://your-domain.atlassian.net/wiki/api/v2/whiteboards/${id}/direct-children`;
  const config = {
    headers: {
      'Accept': 'application/json'
    }
  };

  try {
    const response = await axios.get(url, config);
    return response.data;
  } catch (error) {
    console.error('Error fetching whiteboard children:', error);
    throw error;
  }
};

// Example usage:
// getWhiteboardChildren('{id}').then(data => console.log(data)).catch(error => console.error(error));
```

--------------------------------

### Response Body for Get Labels

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-label

This is an example of the JSON response body when retrieving labels for an attachment. It includes a list of labels and links for pagination.

```json
{ "results": [ { "id": "<string>", "name": "<string>", "prefix": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }
```

--------------------------------

### Space permission transition task status response example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permission-transition

This is an example of a successful response when retrieving the status of a space permission transition task. It includes the taskId, current status, and an error message if applicable.

```json
{ "taskId": "<string>", "status": "IN_PROGRESS", "errorMessage": "<string>" }
```

--------------------------------

### Get blog post classification level using cURL

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-classification-level

This example shows how to fetch the classification level of a blog post using cURL. Replace '{id}' with the actual blog post ID.

```bash
curl - GET https://your-domain.atlassian.net/wiki/api/v2/blogposts/{id}/classification-level
```

--------------------------------

### Get Folder by ID using Forge

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder

Use this snippet to retrieve a specific folder by its ID. Ensure you have the necessary OAuth 2.0 or Connect app scopes. This example uses Atlassian Forge.

```javascript
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestConfluence } from "@forge/bridge";

const response = await requestConfluence(`/wiki/api/v2/folders/{id}`, {
  headers: { 'Accept': 'application/json' }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());
```

--------------------------------

### Create a Space Role Response (JSON)

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-roles

Example of a successful 201 Created response when creating a space role. The response includes the ID, type, name, description, and space permissions of the newly created role.

```json
{ "id": "<string>", "type": "SYSTEM", "name": "<string>", "description": "<string>", "spacePermissions": [ "<string>" ] }
```

--------------------------------

### Example JSON response for getting an app property

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-app-properties

Illustrates the structure of a successful JSON response when retrieving a Forge app property. It includes the property's key and its associated value, which can be any JSON object.

```json
{ "key": "user-preferences", "value": { "theme": "dark", "language": "en" } }
```

--------------------------------

### GET /databases/{id} - Get database by id

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database

Retrieves a specific database by its ID.

```APIDOC
## GET /databases/{id} - Get database by id

### Description
Retrieves a specific database by its ID.

### Method
GET

### Endpoint
/wiki/api/v2/databases/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the database to retrieve.

### Responses
#### Success Response (200 OK)
Returned if the database was successfully retrieved.
- **DatabaseSingle** (object) - Contains the details of the database.

#### Error Responses
- **404 Not Found**
```

--------------------------------

### Attachment content property response example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties

This is an example of a successful response when creating a content property for an attachment.

```json
{ "id": "<string>", "key": "<string>", "version": { "createdAt": "<string>", "message": "<string>", "number": 19, "minorEdit": true, "authorId": "<string>" } }
```

--------------------------------

### GET /embeds/{id} - Get Smart Link

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link

Retrieves a specific Smart Link from the content tree by its ID.

```APIDOC
## GET /embeds/{id} - Get Smart Link

### Description
Gets a Smart Link from the content tree by its ID.

### Method
GET

### Endpoint
/wiki/api/v2/embeds/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the Smart Link to retrieve.

### Responses
#### Success Response (200 OK)
Returned if the Smart Link was successfully retrieved.
- **id** (string)
- **type** (string)
- **status** (string) - e.g., "current"
- **title** (string)
- **parentId** (string)
- **parentType** (string) - e.g., "page"
- **position** (integer)
- **authorId** (string)
- **ownerId** (string)
- **createdAt** (string)
- **embedUrl** (string)
- **spaceId** (string)
- **version** (object)
  - **createdAt** (string)
  - **message** (string)
  - **number** (integer)
  - **minorEdit** (boolean)
  - **authorId** (string)
- **_links** (object)
  - **base** (string)

#### Response Example
```json
{
  "id": "<string>",
  "type": "<string>",
  "status": "current",
  "title": "<string>",
  "parentId": "<string>",
  "parentType": "page",
  "position": 61,
  "authorId": "<string>",
  "ownerId": "<string>",
  "createdAt": "<string>",
  "embedUrl": "<string>",
  "spaceId": "<string>",
  "version": {
    "createdAt": "<string>",
    "message": "<string>",
    "number": 19,
    "minorEdit": true,
    "authorId": "<string>"
  },
  "_links": {
    "base": "<string>"
  }
}
```

#### Error Responses
- **404 Not Found**
```

--------------------------------

### Create Whiteboard Response

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard

Example JSON response when a whiteboard is successfully created. It includes the whiteboard's ID, type, status, title, parent information, creation timestamps, author and owner IDs, and space ID.

```json
{ 
  "id": "<string>", 
  "type": "<string>", 
  "status": "current", 
  "title": "<string>", 
  "parentId": "<string>", 
  "parentType": "page", 
  "position": 61, 
  "authorId": "<string>", 
  "ownerId": "<string>", 
  "createdAt": "<string>", 
  "spaceId": "<string>", 
  "version": { 
    "createdAt": "<string>", 
    "message": "<string>", 
    "number": 19, 
    "minorEdit": true, 
    "authorId": "<string>"
  }, 
  "_links": {
    "base": "<string>"
  }
}
```

--------------------------------

### Example JSON response for children inline comments

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-comment

This is an example of the JSON structure returned when requesting children inline comments.

```json
{
  "results": [
    {
      "id": "<string>",
      "status": "current",
      "title": "<string>",
      "parentCommentId": "<string>",
      "version": {
        "createdAt": "<string>",
        "message": "<string>",
        "number": 19,
        "minorEdit": true,
        "authorId": "<string>"
      },
      "body": {
        "storage": {},
        "atlas_doc_format": {}
      },
      "resolutionStatus": "open",
      "properties": {
        "inlineMarkerRef": "<string>",
        "inlineOriginalSelection": "<string>"
      },
      "_links": {
        "webui": "<string>"
      }
    }
  ],
  "_links": {
    "next": "<string>",
    "base": "<string>"
  }
}
```

--------------------------------

### Response for Creating Content Property

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties

Example of a successful response when creating a content property for a folder. Includes the property ID, key, and version information.

```json
{
  "id": "<string>",
  "key": "<string>",
  "version": {
    "createdAt": "<string>",
    "message": "<string>",
    "number": 19,
    "minorEdit": true,
    "authorId": "<string>"
  }
}
```

--------------------------------

### Space Properties Response Example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties

An example of the JSON response structure when retrieving space properties. It includes an array of property objects, each with an ID, key, creation timestamp, creator, and version information.

```json
{ "results": [ { "id": "<string>", "key": "<string>", "createdAt": "<string>", "createdBy": "<string>", "version": { "createdAt": "<string>", "createdBy": "<string>", "message": "<string>", "number": 44 } } ], "_links": { "next": "<string>", "base": "<string>" } }
```

--------------------------------

### Confluence Blog Post JSON Response Example

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-blog-post

This is an example of the JSON response structure when successfully retrieving a blog post. It includes details about the blog post's content, metadata, labels, properties, operations, likes, and versions.

```json
{
  "id": "<string>",
  "status": "current",
  "title": "<string>",
  "spaceId": "<string>",
  "authorId": "<string>",
  "createdAt": "<string>",
  "version": {
    "createdAt": "<string>",
    "message": "<string>",
    "number": 19,
    "minorEdit": true,
    "authorId": "<string>"
  },
  "body": {
    "storage": {},
    "atlas_doc_format": {},
    "view": {}
  },
  "labels": {
    "results": [
      {
        "id": "<string>",
        "name": "<string>",
        "prefix": "<string>"
      }
    ],
    "meta": {
      "hasMore": true,
      "cursor": "<string>"
    },
    "_links": {
      "self": "<string>"
    }
  },
  "properties": {
    "results": [
      {
        "id": "<string>",
        "key": "<string>",
        "version": {}
      }
    ],
    "meta": {
      "hasMore": true,
      "cursor": "<string>"
    },
    "_links": {
      "self": "<string>"
    }
  },
  "operations": {
    "results": [
      {
        "operation": "<string>",
        "targetType": "<string>"
      }
    ],
    "meta": {
      "hasMore": true,
      "cursor": "<string>"
    },
    "_links": {
      "self": "<string>"
    }
  },
  "likes": {
    "results": [
      {
        "accountId": "<string>"
      }
    ],
    "meta": {
      "hasMore": true,
      "cursor": "<string>"
    },
    "_links": {
      "self": "<string>"
    }
  },
  "versions": {
    "results": [
      {
        "createdAt": "<string>",
        "message": "<string>",
        "number": 19,
        "minorEdit": true,
        "authorId": "<string>"
      }
    ],
    "meta": {
      "hasMore": true,
      "cursor": "<string>"
    },
    "_links": {
      "self": "<string>"
    }
  },
  "isFavoritedByCurrentUser": true,
  "_links": {
    "self": "<string>"
  }
}
```

--------------------------------

### Example Ancestor Response

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-ancestors

This is an example of a successful response when retrieving ancestors. The response includes a list of ancestor entities, each with an ID and type.

```json
{
  "results": [
    { "id": "<string>", "type": "page" }
  ]
}
```

--------------------------------

### Blog Post Like Count Response (JSON)

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like

Example JSON response when successfully retrieving the like count for a blog post.

```json
{ "count": 16 }
```

--------------------------------

### GET /pages/{page-id}/versions/{version-number}

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version

Retrieves specific details for a particular version of a page. Use this to get information about a historical version.

```APIDOC
## GET /pages/{page-id}/versions/{version-number}

### Description
Retrieves specific details for a particular version of a page.

### Method
GET

### Endpoint
/pages/{page-id}/versions/{version-number}

### Parameters
#### Path Parameters
- **page-id** (string) - Required - The ID of the page.
- **version-number** (integer) - Required - The version number of the page.
```

--------------------------------

### GET /attachments/{attachment-id}/versions/{version-number}

Source: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version

Retrieves specific details for a particular version of an attachment. Use this to get information about a historical version.

```APIDOC
## GET /attachments/{attachment-id}/versions/{version-number}

### Description
Retrieves specific details for a particular version of an attachment.

### Method
GET

### Endpoint
/attachments/{attachment-id}/versions/{version-number}

### Parameters
#### Path Parameters
- **attachment-id** (string) - Required - The ID of the attachment.
- **version-number** (integer) - Required - The version number of the attachment.
```