> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Spaces

Get a list of spaces.

**Required Permission:**

* read:space:confluence.

<Note>
  External Documentation

  To learn more, visit the [Confluence documentation](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space/#api-spaces-get).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter  | Description                                                                                                                |
  | ---------- | -------------------------------------------------------------------------------------------------------------------------- |
  | Limit      | The maximum number of spaces to return in a single response.<br /><br />Values can range from `1` to `250`.                |
  | Space IDs  | A comma-separated list of space IDs to filter results by.<br /><br />**Note:** A maximum of `250` items can be specified.  |
  | Space Keys | A comma-separated list of space keys to filter results by.<br /><br />**Note:** A maximum of `250` items can be specified. |
  | Status     | Select the status of spaces to filter results by.                                                                          |
  | Type       | Select the type of spaces to filter results by.                                                                            |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter          | Description                                                                                                |
  | ------------------ | ---------------------------------------------------------------------------------------------------------- |
  | Description Format | Select the content format to be returned in the `description` field of the response.                       |
  | Favorited By       | The account ID of the user whose favorited spaces should be returned.                                      |
  | Include Icon       | Select to fetch the icon for the space.                                                                    |
  | Labels             | A comma-separated list of labels to filter results by.                                                     |
  | Not Favorited By   | The account ID of the user whose non-favorited spaces should be returned.                                  |
  | Sort               | Select the primary field for sorting the results. Prefix the value with a minus sign for descending order. |
</div>

## Example Output

```json theme={"dark"}
{
	"results": [
		{
			"id": "<string>",
			"key": "<string>",
			"name": "<string>",
			"type": "global",
			"status": "current",
			"authorId": "<string>",
			"spaceOwnerId": "<string>",
			"currentActiveAlias": "<string>",
			"createdAt": "<string>",
			"homepageId": "<string>",
			"description": {
				"plain": {},
				"view": {}
			},
			"icon": {
				"path": "<string>",
				"apiDownloadLink": "<string>"
			},
			"_links": {
				"webui": "<string>"
			}
		}
	],
	"_links": {
		"next": "<string>",
		"base": "<string>"
	}
}
```

## Workflow Library Example

[List Spaces with Confluence and Send Results Via Email](https://library.blinkops.com/workflows/list-spaces-with-confluence-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/list-spaces-with-confluence-and-send-results-via-email/canvas" />
</div>