Interface GetSpaceProperties

interface GetSpaceProperties {
    expand?: string[];
    limit?: number;
    spaceKey: string;
    start?: number;
}

Properties

expand? limit? spaceKey start?

Properties

Optional expand

expand?: string[]

A multi-value parameter indicating which properties of the space property to expand. By default, the version object is expanded.

  • version returns information about the version of the content.
  • space returns the space that the properties are in.

Optional limit

limit?: number

The maximum number of properties to return per page. Note, this may be restricted by fixed system limits.

spaceKey

spaceKey: string

The key of the space to be queried for its properties.

Optional start

start?: number

The starting index of the returned objects.

Settings

Member Visibility

Theme

On This Page

expandlimitspaceKeystart

Generated using TypeDoc v0.25.12