Interface UsersApiListUsersRequest

Request parameters for listUsers operation in UsersApi.

Export

UsersApiListUsersRequest

Hierarchy

  • UsersApiListUsersRequest

Properties

include_connected_accounts? limit? offset? tilled_account

Properties

Optional Readonly include_connected_accounts

include_connected_accounts?: boolean

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

Memberof

UsersApiListUsers

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

UsersApiListUsers

Optional Readonly offset

offset?: number

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

Memberof

UsersApiListUsers

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

UsersApiListUsers

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc