Confluence.js - Cloud and Server API library
    Preparing search index...

    Interface GetSpaces

    interface GetSpaces {
        expand?:
            | string
            | string[]
            | (
                | "metadata"
                | "description"
                | "history"
                | "settings"
                | "metadata.labels"
                | "operations"
                | "lookAndFeel"
                | "permissions"
                | "icon"
                | "description.plain"
                | "description.view"
                | "theme"
                | "homepage"
            )[];
        favourite?: boolean;
        favouriteUserKey?: string;
        label?: string[];
        limit?: number;
        spaceId?: number[];
        spaceKey?: string[];
        start?: number;
        status?: string;
        type?: string;
    }
    Index

    Properties

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

    Properties

    expand?:
        | string
        | string[]
        | (
            | "metadata"
            | "description"
            | "history"
            | "settings"
            | "metadata.labels"
            | "operations"
            | "lookAndFeel"
            | "permissions"
            | "icon"
            | "description.plain"
            | "description.view"
            | "theme"
            | "homepage"
        )[]

    A multi-value parameter indicating which properties of the content to expand.

    favourite?: boolean

    Filter the results to the favourite spaces of the user specified by favouriteUserKey. Note, 'favourite' spaces are also known as 'saved for later' spaces.

    favouriteUserKey?: string

    The userKey of the user, whose favourite spaces are used to filter the results when using the favourite parameter.

    Leave blank for the current user. Use Get user to get the userKey for a user.

    label?: string[]

    Filter the results to spaces based on their label.

    limit?: number

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

    spaceId?: number[]

    The id of the space to be returned. To return multiple spaces, specify this parameter multiple times with different values.

    spaceKey?: string[]

    The key of the space to be returned. To return multiple spaces, specify this parameter multiple times with different values.

    start?: number

    The starting index of the returned spaces.

    status?: string

    Filter the results to spaces based on their status.

    type?: string

    Filter the results to spaces based on their type.

    Settings

    Member Visibility

    On This Page

    Properties