List Custom Field Groups
Retrieve a list of custom field groups from SmartHR.
Choose one of the following options to return your results:
To learn how to return large numbers of records, see Set up the stream matching option with a helper flow.
|Include Custom Fields?||
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.
Specify the number of records to stream.
This field appears when Stream Records is selected from the Result Set option.
|Custom Field Groups||Object|
|Custom Field Group ID||Unique identifier for the custom field group.||Text|
|Name||Name of the custom field group.||Text|
|Position||Position of the custom field group.||Number|
|Access Type||Access type.||Text|
|Created At||Date created.||Date & Time|
|Updated At||Last updated.||Date & Time|
Custom fields associated with the custom field group.
Number of records streamed in a streaming flow.
This field appears when you select Stream Records from the Result Set option.