List Groups

Retrieve a list of all groups in KnowBe4.

Options

Field Definition Type Required

Result Set

Choose a method to filter search results:

  • First 200 Records: Returns the first 200 matching records.

  • Stream Records: Passes all matching user records from your parent flow to a helper flow.

    Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add custom extensible fields.

Dropdown

TRUE

To learn how to return large numbers of records, see Stream matching records with a helper flow.

Input

Field Definition Type Required

Filters

Status

Status of the groups you're searching for. Select one of the following values:

  • Active

  • Archived

  • All

Dropdown

FALSE

Streaming

Flow

Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm.

Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow.

This field appears when Stream Records is selected from the Result Set field.

The input field on the Helper Card in the streaming helper flow must reference the key Record (type object) to obtain streamed records. To obtain state input values, reference the key State (type object) of the Record object.

Flow

TRUE

Record Limit

Specify the number of records to stream.

  • When the Record Limit field is set the 0 value for the field isn't allowed.

  • When the Record Limit field is set to greater than 0, records greater than 0 and up to the maximum number of records specified are returned.

  • When the Record Limit field is empty, null or not selected, all records are streamed.

  • The default value is 2500000.

  • The valid range is from 1 to 2500000.

This field appears when Stream Records is selected from the Result Set option.

Number

FALSE

Output

Field Definition Type

Result

Groups

List of Objects

ID

Unique identifier of the group.

Number

Name

Name of the group.

Text

Type

Indicates the group type. The result is one of console_group, smart_group, or provisioning_managed_group.

Text

Provisioning GUID

If applicable, the user provisioning GUID.

Text

Members Count

Number of members in the group.

Number

Group Risk Score

Group current risk score.

Number

Status

Status of the group. The result is either active or archived.

Text

Records Streamed

Number of records streamed in a streaming flow.

This field appears when you select Stream Records from the Result Set option.

Number

Related topics

KnowBe4 connector

Cards in flows

KnowBe4 Reporting API