tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > ListsService > getGroups

ListsService.getGroups() method

Gets a list of Groups. This operation returns an instance of ‘Group’ type.

Signature:

static getGroups({ inPublicationId, includeEveryone, search, searchMode, }: {
        inPublicationId?: string;
        includeEveryone?: boolean;
        search?: string;
        searchMode?: 'Contains' | 'StartsWith' | 'EndsWith' | 'ExactMatch';
    }): CancelablePromise<Array<Group>>;

Parameters

Parameter	Type	Description
{ inPublicationId, includeEveryone, search, searchMode, }	{ inPublicationId?: string; includeEveryone?: boolean; search?: string; searchMode?: ‘Contains’ | ‘StartsWith’ | ‘EndsWith’ | ‘ExactMatch’; }

Returns:

CancelablePromise<Array<Group>>

Group The request was successful.

Exceptions

ApiError