---
title: "Get space by id"
method: GET
path: "/spaces/{id}"
tags: ["Space"]
---

# Get space by id

`GET /spaces/{id}`

Returns a specific space.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the space.

## Path parameters

- `id` integer, required

## Query parameters

- `description-format` 'plain' | 'view' — The formats a space description can be represented as. A subset of BodyRepresentation.
- `include-icon` boolean
- `include-operations` boolean
- `include-properties` boolean
- `include-permissions` boolean
- `include-role-assignments` boolean
- `include-labels` boolean

## Response `200`

Returned if the requested space is returned.

- object
  - `id` string — ID of the space.
  - `key` string — Key of the space.
  - `name` string — Name of the space.
  - `type` 'global' | 'collaboration' | 'knowledge_base' | 'personal' | 'system' | 'onboarding' | 'xflow_sample_space' — The type of space.
  - `status` 'current' | 'archived' — The status of the space.
  - `authorId` string — The account ID of the user who created this space originally.
  - `spaceOwnerId` string — The account ID of the user who owns this space.
  - `createdAt` string, date-time — Date and time when the space was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".
  - `homepageId` string — ID of the space's homepage.
  - `description` SpaceDescription — Contains fields for each representation type requested.
    - `plain` BodyType
      - `representation` string — Type of content representation used for the value field.
      - `value` string — Body of the content, in the format found in the representation field.
    - `view` BodyType
      - `representation` string — Type of content representation used for the value field.
      - `value` string — Body of the content, in the format found in the representation field.
  - `icon` SpaceIcon — The icon of the space
    - `path` string — The path (relative to base URL) at which the space's icon can be retrieved. The format should be like `/wiki/download/...` or `/wiki/aa-avatar/...`
    - `apiDownloadLink` string — The path (relative to base URL) that can be used to retrieve a link to download the space icon. 3LO apps should use this link instead of the value provided in the `path` property to retrieve the icon. Currently this field is only returned for `global` spaces and not `personal` spaces.
  - `labels` object
    - `results` Label[]
      - `id` string — ID of the label.
      - `name` string — Name of the label.
      - `prefix` string — Prefix of the label.
    - `meta` OptionalFieldMeta
      - `hasMore` boolean — Indicates if there are more available results that can be fetched.
      - `cursor` string — A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results.
    - `_links` OptionalFieldLinks
      - `self` string — A relative URL that can be used to fetch results beyond what this include parameter retrieves.
  - `properties` object
    - `results` SpaceProperty[]
      - `id` string — ID of the space property.
      - `key` string — Key of the space property.
      - `value` unknown
      - `createdAt` string, date-time — RFC3339 compliant date time at which the property was created.
      - `createdBy` string — Atlassian account ID of the user that created the space property.
      - `version` object
        - `createdAt` string, date-time — RFC3339 compliant date time at which the property's current version was created.
        - `createdBy` string — Atlassian account ID of the user that created the space property's current version.
        - `message` string — Message associated with the current version.
        - `number` integer — The space property's current version number.
    - `meta` OptionalFieldMeta
      - `hasMore` boolean — Indicates if there are more available results that can be fetched.
      - `cursor` string — A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results.
    - `_links` OptionalFieldLinks
      - `self` string — A relative URL that can be used to fetch results beyond what this include parameter retrieves.
  - `operations` object
    - `results` Operation[]
      - `operation` string — The type of operation.
      - `targetType` string — The type of entity the operation type targets.
    - `meta` OptionalFieldMeta
      - `hasMore` boolean — Indicates if there are more available results that can be fetched.
      - `cursor` string — A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results.
    - `_links` OptionalFieldLinks
      - `self` string — A relative URL that can be used to fetch results beyond what this include parameter retrieves.
  - `permissions` object
    - `results` SpacePermissionAssignment[]
      - `id` string — ID of the space permission.
      - `principal` object — The entity the space permissions corresponds to.
        - `type` 'user' | 'group' | 'role'
        - `id` string — ID of the entity.
      - `operation` object — The operation the space permission corresponds to.
        - `key` 'use' | 'create' | 'read' | 'update' | 'delete' | 'copy' | 'move' | 'export' | 'purge' | 'purge_version' | 'administer' | 'restore' | 'create_space' | 'restrict_content' | 'archive' — The type of operation.
        - `targetType` 'page' | 'blogpost' | 'comment' | 'attachment' | 'whiteboard' | 'database' | 'embed' | 'folder' | 'space' | 'application' | 'userProfile' — The type of entity the operation type targets.
    - `meta` OptionalFieldMeta
      - `hasMore` boolean — Indicates if there are more available results that can be fetched.
      - `cursor` string — A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results.
    - `_links` OptionalFieldLinks
      - `self` string — A relative URL that can be used to fetch results beyond what this include parameter retrieves.
  - `_links` object
    - `webui` string — Web UI link of the space.
    - `base` string — Base url of the Confluence site.

## Other responses

- `400` — Returned if an invalid request is provided.
- `401` — Returned if the authentication credentials are incorrect or missing from the request.
- `404` — Returned if the calling user does not have permission to view the requested space or the space was not found.

---

[API](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api-v2.md) · [All operations](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-confluence-cloud-rest-api-v2/revisions/c4bd1ed570f2/schema)