Interface EventsApiListEventsRequest

Request parameters for listEvents operation in EventsApi.

Export

EventsApiListEventsRequest

Hierarchy

  • EventsApiListEventsRequest

Properties

created_at_gte? created_at_lte? include_connected_accounts? limit? object_id? offset? tilled_account types?

Properties

Optional Readonly created_at_gte

created_at_gte?: string

Minimum `created_at` value to filter by (inclusive). Default is 30 days in the past.

Memberof

EventsApiListEvents

Optional Readonly created_at_lte

created_at_lte?: string

Maximum `created_at` value to filter by (inclusive). Default is current date.

Memberof

EventsApiListEvents

Optional Readonly include_connected_accounts

include_connected_accounts?: boolean

Whether or not to include the results from any connected accounts.

Memberof

EventsApiListEvents

Optional Readonly limit

limit?: number

The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

Memberof

EventsApiListEvents

Optional Readonly object_id

object_id?: string

Id of related resource. The list will be filtered to include events that are related to the resource with this id.

Memberof

EventsApiListEvents

Optional Readonly offset

offset?: number

The (zero-based) offset of the first item in the collection to return.

Memberof

EventsApiListEvents

Readonly tilled_account

tilled_account: string

The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

Memberof

EventsApiListEvents

Optional Readonly types

types?: ListEventsTypes[]

An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property.

Memberof

EventsApiListEvents

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc