Spaces
Retrieves metadata and configuration details about spaces, including names, keys, descriptions, and access settings.
Table Specific Information
Select
The server will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the server. You can also search for Attachments using CQL (Confluence Query Language).
- Key supports the '=,!=,IN,NOT IN' comparisons.
- Name supports the '=,LIKE,NOT LIKE' comparisons.
- Type supports the '=,!=,IN,NOT IN' comparisons.
- Excerpt supports the '=' comparisons.
For example, the following queries are processed server side:
SQL
SELECT * FROM Spaces WHERE Key = 'abc'
SELECT * FROM Spaces WHERE Name IN ('name1', 'name2')
SELECT * FROM Spaces WHERE Excerpt = 'driver development'
SELECT * FROM Spaces WHERE Key = 'abc' AND Type = 'global'
CQL
Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.
SELECT * FROM Spaces WHERE CQL = 'type = space AND space.title~"Driver Development"' AND Excerpt = 'indexed'
Columns
| Name | Type | References | SupportedOperators | Description |
| Id | String | The unique identifier of the space within Confluence. Used to reference the space in related tables and operations. | ||
| Key [KEY] | String | =,!=,IN,NOT_IN | The unique key assigned to the space, typically a short code used in URLs and API requests. | |
| Name | String | =,!= | The display name of the space as shown in the Confluence interface. | |
| IconPath | String | The file path or URL to the space's icon image. | ||
| IconWidth | Integer | The width, in pixels, of the space icon image. | ||
| IconHeight | Integer | The height, in pixels, of the space icon image. | ||
| IsIconDefault | Boolean | If the value is 'true', the space uses the default Confluence icon. If the value is 'false', a custom icon has been set. | ||
| Excerpt | String | A short description or summary of the space content, typically shown in listings or search results. | ||
| Type | String | =,!=,IN,NOT_IN | Specifies the type of space, such as global, personal, or team. | |
| Url | String | The full URL used to access the space through the Confluence interface or API. | ||
| LastModified | Datetime | The date and time when the space or its metadata was last modified. | ||
| ItemURL | String | The complete URL reference to the space as displayed in the Confluence user interface. | ||
| Description | String | A detailed description of the space, outlining its purpose and content focus. | ||
| CreatedDate | Datetime | =,>,>=,<,<= | The date and time when the space was originally created. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| CQL | String | Represents a Confluence Query Language (CQL) expression used to construct structured queries for retrieving or filtering spaces. |