Type Alias: GetActivitiesData

[object Object]

Defined in: api/types.gen.ts:2037

Properties

body?

optional body?: never

Defined in: api/types.gen.ts:2038

---

path?

optional path?: never

Defined in: api/types.gen.ts:2039

---

query?

optional query?: object

Defined in: api/types.gen.ts:2040

IncludeFuture?

optional IncludeFuture?: boolean

Indicates whether to include future activities in the response. If set to true, activities that are scheduled for the future will be included in the response; if set to false, only past activities will be included.

IncludePast?

optional IncludePast?: boolean

Indicates whether to include past activities in the response. If set to true, activities that have already occurred will be included in the response; if set to false, only upcoming activities will be included.

OpenForPayment?

optional OpenForPayment?: boolean

Indicates whether to include activities that are open for payment in the response. If set to true, activities that are currently open for payment will be included in the response; if set to false, only activities that are not open for payment will be included.

Page?

optional Page?: number

The page number for pagination (1-indexed). If specified with PageSize, pagination will be applied.

PageSize?

optional PageSize?: number

The page size for pagination. Defaults to 50 if Page is specified without PageSize.

UserId?

optional UserId?: string

The ID of the user for whom to retrieve activities. This property can be used to filter activities based on the user's enrollments or other criteria related to the user's participation in activities.

Year?

optional Year?: number

Indicates the year for which to retrieve activities. If specified, only activities that are associated with the given year will be included in the response.

---

url

[object Object]

Defined in: api/types.gen.ts:2070