Interface GetConnectionsRequest

Hierarchy

  • GetConnectionsRequest

Properties

fields?: string

A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields

from?: string

Optional Id from which to start selection.

include_fields?: boolean

true if the fields specified are to be included in the result, false otherwise (defaults to true)

include_totals?: boolean

true if a query summary must be included in the result, false otherwise. Not returned when using checkpoint pagination. Default false.

name?: string

Provide the name of the connection to retrieve

page?: number

The page number. Zero based

per_page?: number

The amount of entries per page. Default: no paging is used, all connections are returned

Provide strategies to only retrieve connections with such strategies

take?: number

Number of results per page. Defaults to 50.