Function: getActivities()

getActivities<ThrowOnError>(options?): RequestResult<GetActivitiesResponses, GetActivitiesErrors, ThrowOnError>

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

Retrieves a list of activities based on the provided query parameters. The GetActivities endpoint allows clients to fetch a collection of activities, optionally filtered and paginated according to the criteria specified in the GetActivitiesDTO. This endpoint is designed to return a comprehensive list of activities that match the given parameters, enabling clients to efficiently retrieve relevant activity data while supporting various filtering and pagination options for optimal performance and usability.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<GetActivitiesData, ThrowOnError>

Returns

RequestResult<GetActivitiesResponses, GetActivitiesErrors, ThrowOnError>