GetMembers

Function: getMembers()

getMembers<ThrowOnError>(options?): RequestResult<GetMembersResponses, GetMembersErrors, ThrowOnError>

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

Retrieves a filtered and paginated list of members. The GetMembers endpoint allows authorized users to search through the system's member directory using criteria specified in the GetMembersDto. This endpoint is designed to return summarized member profiles, facilitating directory browsing and administrative oversight while respecting privacy constraints and authorization rules.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<GetMembersData, ThrowOnError>

Returns

RequestResult<GetMembersResponses, GetMembersErrors, ThrowOnError>

On this page