Interface GetSpaces

interface GetSpaces {
    expand?: string;
    favourite?: boolean;
    label?: string;
    limit?: number;
    spaceKey?: string;
    start?: number;
    status?: string;
    type?: string;
}

Properties

expand? favourite? label? limit? spaceKey? start? status? type?

Properties

Optional expand

expand?: string

A comma separated list of properties to expand on the spaces

Optional favourite

favourite?: boolean

Filter the list of spaces returned by favourites

Optional label

label?: string

Filter the list of spaces returned by label

Optional limit

limit?: number

The limit of the number of spaces to return, this may be restricted by fixed system limits

Optional spaceKey

spaceKey?: string

A list of space keys

Optional start

start?: number

The start point of the collection to return

Optional status

status?: string

Filter the list of spaces returned by status (current, archived)

Optional type

type?: string

Filter the list of spaces returned by type (global, personal)

Settings

Member Visibility

Theme

On This Page

expandfavouritelabellimitspaceKeystartstatustype

Generated using TypeDoc v0.25.12