Function: getGroupsById()

getGroupsById<ThrowOnError>(options): RequestResult<GetGroupsByIdResponses, GetGroupsByIdErrors, ThrowOnError>

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

Retrieves the detailed information of a specific group by its unique identifier. The GetGroup endpoint is designed to return a single, comprehensive group record based on the provided ID. This allows clients to access full details about a specific group's properties and configuration. If the group is not found within the system, the endpoint provides appropriate error feedback, ensuring the client is aware of the missing resource while maintaining a secure and predictable API response.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<GetGroupsByIdData, ThrowOnError>

Returns

RequestResult<GetGroupsByIdResponses, GetGroupsByIdErrors, ThrowOnError>