GetGroupmembershipsById

Function: getGroupmembershipsById()

getGroupmembershipsById<ThrowOnError>(options): RequestResult<GetGroupmembershipsByIdResponses, GetGroupmembershipsByIdErrors, ThrowOnError>

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

Retrieves a specific group membership by its unique identifier. The GetGroupMembership endpoint allows clients to fetch the details of a single group membership based on the provided ID. This endpoint ensures that the requesting user is authorized to access the group membership information and returns the corresponding GroupMembershipResponseDTO if found. If the specified group membership does not exist, it returns a 404 Not Found status code, and if the user is not authorized to access the resource, it returns a 403 Forbidden status code. Additionally, 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<GetGroupmembershipsByIdData, ThrowOnError>

Returns

RequestResult<GetGroupmembershipsByIdResponses, GetGroupmembershipsByIdErrors, ThrowOnError>

On this page