Function: getGroups()

getGroups<ThrowOnError>(options?): RequestResult<GetGroupsResponses, GetGroupsErrors, ThrowOnError>

Defined in: app/api/sdk.gen.ts:346

Retrieves a collection of groups based on the provided query filters and pagination parameters. The GetGroups endpoint allows clients to fetch a list of groups that match specific criteria defined in the GetGroupDTO. This endpoint is designed to support efficient data retrieval by allowing users to filter through available groups while ensuring that the returned results are scoped according to the user's authorization level. It provides a robust way for clients to browse and search for groups within the application's ecosystem.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<GetGroupsData, ThrowOnError>

Returns

RequestResult<GetGroupsResponses, GetGroupsErrors, ThrowOnError>