Function: getGroupmemberships()

getGroupmemberships<ThrowOnError>(options?): RequestResult<GetGroupmembershipsResponses, GetGroupmembershipsErrors, ThrowOnError>

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

Retrieves a list of group memberships based on the provided query parameters. The GetGroupMemberships endpoint allows clients to fetch a collection of group memberships that match the specified criteria, such as filtering by group ID, member ID, or other relevant parameters defined in the GetGroupMembershipsDTO. This endpoint ensures that the requesting user is authorized to access the group membership information and returns a list of GroupMembershipResponseDTO objects that represent the matching group memberships. If no group memberships are found that match the criteria, it returns an empty list with a 200 OK status code. Additionally, if the user is not authorized to access the resource, it returns a 403 Forbidden status code, and any other exceptions encountered during the process will result in a 400 Bad Request response with an appropriate error message.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<GetGroupmembershipsData, ThrowOnError>

Returns

RequestResult<GetGroupmembershipsResponses, GetGroupmembershipsErrors, ThrowOnError>