Function: getAnnouncements()

getAnnouncements<ThrowOnError>(options?): RequestResult<GetAnnouncementsResponses, GetAnnouncementsErrors, ThrowOnError>

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

Retrieves a list of all announcements. The GetAnnouncements endpoint allows clients to fetch a collection of announcements that have been created within the system. This endpoint is designed to return a list of announcements, ensuring that proper authorization is enforced to allow only authorized users to access the announcement data, while also providing appropriate error handling for cases where announcements may not be found or the user does not have access rights. Upon successful retrieval, the endpoint returns a list of announcements with a 200 OK status code, allowing clients to easily access and display announcement information as needed. This endpoint provides a convenient way for clients to stay informed about important updates, events, or news related to the organization or community by accessing the latest announcements available within the system.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<GetAnnouncementsData, ThrowOnError>

Returns

RequestResult<GetAnnouncementsResponses, GetAnnouncementsErrors, ThrowOnError>