Appearance

Get Spaces ​

Endpoint ​

http
GET /unified/knowledge-base/spaces/{id}
Integrations supported
  • Confluence
  • Confluence On Prem
  • Help Scout Docs
  • SharePoint

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body ​

id
string
REQUIRED · 

The unique identifier for the space

Supported in
  • Confluence
  • Confluence On Prem
  • Help Scout Docs
  • SharePoint
identifier
string

A human readable identifier for the space. Usually is a shortened version on the name.

Supported in
  • Confluence
  • Confluence On Prem
name
string

The name of the space

Supported in
  • Confluence
  • Confluence On Prem
  • Help Scout Docs
  • SharePoint
description
string

The description of the space

Supported in
  • Help Scout Docs
  • SharePoint
status
string

The status of the space

All possible enum values:
  • active
  • archived
Supported in
  • Confluence
  • Confluence On Prem
  • Help Scout Docs
urls
object[]

The urls of the space

Supported in
  • Help Scout Docs
  • SharePoint
url
string

The url of the space

type
string

The type of the url

All possible enum values:
  • view
  • edit
  • public_view
created_at
string · date-time

The date and time the space was created

Supported in
  • Confluence
  • Confluence On Prem
  • Help Scout Docs
  • SharePoint
updated_at
string · date-time

The date and time the space was last updated

Supported in
  • Help Scout Docs
  • SharePoint
remote_data
object

Raw data returned from the remote API call.