docs/interfaces/management.Management.ListGroupsRequestParameters.html
{ * connection_id: "connection_id", * name: "name", * external_id: "external_id", * search: "search", * fields: "fields", * include_fields: true, * from: "from", * take: 1 * }Copy
interface ListGroupsRequestParameters {
connection_id?: string | null;
name?: string | null;
external_id?: string | null;
search?: string | null;
fields?: string | null;
include_fields?: boolean | null;
from?: string | null;
take?: number | null;
}
connection_id?name?external_id?search?fields?include_fields?from?take?
Optionalconnection_idconnection_id?: string | null
Filter groups by connection ID.
Optionalnamename?: string | null
Filter groups by name.
Optionalexternal_idexternal_id?: string | null
Filter groups by external ID.
Optionalsearchsearch?: string | null
Search for groups by name or external ID.
Optionalfieldsfields?: string | null
A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields
Optionalinclude_fieldsinclude_fields?: boolean | null
Whether specified fields are to be included (true) or excluded (false).
Optionalfromfrom?: string | null
Optional Id from which to start selection.
Optionaltaketake?: number | null
Number of results per page. Defaults to 50.
Member Visibility
ThemeOSLightDark
Properties connection_idnameexternal_idsearchfieldsinclude_fieldsfromtake