Function: getMailinglists()

getMailinglists<ThrowOnError>(options?): RequestResult<GetMailinglistsResponses, GetMailinglistsErrors, ThrowOnError>

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

Retrieves a list of all mailing lists. This endpoint allows authorized users to fetch the complete collection of mailing lists available in the system. The method calls the GetMailinglists function of the IMailinglistService, which interacts with the data layer to retrieve the mailing list entities. The result is returned as an HTTP 200 OK response containing the list of mailing lists. If any exceptions occur during the process, appropriate error responses are returned, such as 403 Forbidden for unauthorized access or 400 Bad Request for other errors. This endpoint is essential for displaying available mailing lists to users and enabling them to manage their email communication preferences effectively.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<GetMailinglistsData, ThrowOnError>

Returns

RequestResult<GetMailinglistsResponses, GetMailinglistsErrors, ThrowOnError>