New to Corsair? See API access, authentication, and error handling.
Pages
get
pages.get
List Confluence pages
Risk: read
await corsair.confluence.api.pages.get({});
| Name | Type | Required | Description |
|---|---|---|---|
space_id | string | No | Filter by space ID |
title | string | No | Filter pages by title |
status | current | trashed | draft | No | Filter pages by content status |
cursor | string | No | Pagination cursor |
limit | number | No | Maximum number of pages to return |
| Name | Type | Required | Description |
|---|---|---|---|
results | object[] | Yes | — |
_links | object | No | — |
results full type
results full type
{
id: string,
status?: string,
title: string,
spaceId?: string,
parentId?: string | null,
parentType?: string | null,
authorId?: string,
createdAt?: string,
version?: {
createdAt?: string,
message?: string,
number?: number,
minorEdit?: boolean,
authorId?: string
},
body?: {
storage?: {
value?: string,
representation?: string
},
atlas_doc_format?: {
value?: string,
representation?: string
}
},
_links?: {
webui?: string,
editui?: string,
tinyui?: string,
self?: string
}
}[]
_links full type
_links full type
{
next?: string,
base?: string,
self?: string
}
search
pages.search
Search Confluence pages via CQL
Risk: read
await corsair.confluence.api.pages.search({});
| Name | Type | Required | Description |
|---|---|---|---|
cql | string | Yes | Confluence Query Language (CQL) query string |
cqlcontext | string | No | Context for the CQL query |
includeArchivedSpaces | boolean | No | Include archived spaces in results |
limit | number | No | Maximum results |
start | number | No | Pagination offset for the first result |
| Name | Type | Required | Description |
|---|---|---|---|
results | object[] | Yes | — |
start | number | Yes | — |
limit | number | Yes | — |
size | number | Yes | — |
totalSize | number | No | — |
cqlQuery | string | No | — |
searchDuration | number | No | — |
archivedResultCount | number | No | — |
_links | object | No | — |
results full type
results full type
{
content: {
id: string,
type: string,
status?: string,
title: string,
childTypes?: Record<string, any>,
macroRenderedOutput?: Record<string, any>,
restrictions?: Record<string, any>,
_expandable?: Record<string, string>,
_links?: {
webui?: string,
self?: string,
tinyui?: string
}
},
title: string,
excerpt?: string,
url?: string,
resultGlobalContainer?: {
title: string,
displayUrl: string
},
breadcrumbs?: any[],
entityType?: string,
iconCssClass?: string,
lastModified?: string,
friendlyLastModified?: string,
score?: number
}[]
_links full type
_links full type
{
base?: string,
context?: string,
self?: string
}
Spaces
list
spaces.list
List Confluence spaces
Risk: read
await corsair.confluence.api.spaces.list({});
| Name | Type | Required | Description |
|---|---|---|---|
key | string | No | Filter by space key |
type | global | personal | No | Filter by space type |
status | current | archived | No | Filter by space status |
label | string | No | Filter by space label |
cursor | string | No | Pagination cursor |
limit | number | No | Maximum number of spaces to return |
| Name | Type | Required | Description |
|---|---|---|---|
results | object[] | Yes | — |
start | number | No | — |
limit | number | No | — |
size | number | No | — |
_links | Record<string, string> | No | — |
results full type
results full type
{
id?: string,
ari?: string,
key: string,
alias?: string,
name: string,
type?: string,
status?: string,
description?: any,
homepage?: any,
_expandable?: Record<string, string>,
_links?: Record<string, string>
}[]