Class EventsListRequest

The object sent with the request to retrieve a list of events from your organization.

Hierarchy

  • EventsListRequest

Constructors

constructor

Properties

additionalProperties? filter? options? page? sort?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional filter

filter?: EventsQueryFilter

The search and filter query settings.

Optional options

options?: EventsQueryOptions

The global query options that are used. Either provide a timezone or a time offset but not both, otherwise the query fails.

Optional page

page?: EventsRequestPage

Pagination settings.

Optional sort

sort?: EventsSort

The sort parameters when querying events.

Settings

Member Visibility

Theme

Generated using TypeDoc