Interface GetClientsRequest

Hierarchy

  • GetClientsRequest

Properties

app_type?: string

Optional filter by a comma-separated list of application types.

fields?: string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

include_fields?: boolean

Whether specified fields are to be included (true) or excluded (false).

include_totals?: boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

is_first_party?: boolean

Optional filter on whether or not a client is a first-party client.

is_global?: boolean

Optional filter on the global client parameter.

page?: number

Page index of the results to return. First page is 0.

per_page?: number

Number of results per page. Default value is 50, maximum value is 100