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

    Interface SearchGroups

    interface SearchGroups {
        limit?: number;
        query: string;
        shouldReturnTotalSize?: boolean;
        start?: number;
    }
    Index

    Properties

    limit?: number

    The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups.

    query: string

    The search term used to query results.

    shouldReturnTotalSize?: boolean

    Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.

    start?: number

    The starting index of the returned groups.