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

    Interface GetGroupMembersByGroupId

    interface GetGroupMembersByGroupId {
        expand?: string | string[];
        groupId: string;
        limit?: number;
        shouldReturnTotalSize?: boolean;
        start?: number;
    }
    Index

    Properties

    expand? groupId limit? shouldReturnTotalSize? start?

    Properties

    expand?: string | string[]

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

    • operations returns the operations that the user is allowed to do.
    • personalSpace returns the user's personal space, if it exists.
    groupId: string

    The id of the group to be queried for its members.

    limit?: number

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

    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 users.

    Settings

    Member Visibility

    On This Page

    Properties