Skip to main content
Version: Current

Get Folders

Description​

The Get Folders activity retrieves folders from a specified IB Drive folder.

The activity returns a collection of Folder References with expandable metadata.


Common settings​

Use Process Data to bind supported inputs to workflow values or upstream outputs. See Common Activity Features for shared execution, error-handling, and output-persistence settings. Availability depends on the activity.

Design-Time Configuration​

Display Text​

Specifies a user-defined name for the activity.

The display text appears on the workflow canvas and can be used to identify the purpose of the activity.


Folder​

Specifies the IB Drive folder from which folders are to be retrieved.

The folder can be specified using one of the following methods:

MethodDescription
Select DirectorySelect the folder by browsing IB Drive using the folder picker.
By IdSpecify the unique IB Drive item ID of the folder. This is the default method.
By PathSpecify the logical path of the folder within IB Drive, for example /Agents/InvoiceProcessing.

The value can also be provided dynamically using workflow data.


Limit​

Specifies the maximum number of folders to return.

The default value is 50.

For example, if the specified folder contains 100 folders and the Limit is set to 50, the activity returns a maximum of 50 folders.


Execution settings​

Configure Wait All Incoming when execution paths converge, and On Error for failure handling. Select Inherit where available to use the workflow-level error policy.

Outputs​

Folders​

Returns a collection of Folder References for the immediate child folders.

Each folder in the collection contains the following properties:

PropertyDescription
IdThe unique identifier (GUID) of the folder in IB Drive.
NameThe name of the folder.
LocationThe logical path of the folder within IB Drive.
ParentIdThe unique identifier (GUID) of the parent folder containing the folder.
SizeThe size associated with the folder. For folders, this is typically 0.
MimeTypeThe content type associated with the folder, if applicable.
CreatedThe UTC date and time when the folder was created in IB Drive.
ModifiedThe UTC date and time when the folder was last modified.

If no folders are found, the activity returns an empty collection.

The returned folder metadata can be used by downstream activities that require references to IB Drive folders.


Remarks​

  • The specified folder must exist in IB Drive when the activity executes.
  • The activity retrieves folder information without modifying the folders or their contents.
  • The Limit property controls the maximum number of folders returned by the activity.
  • When using By Path, specify the logical path of the folder within IB Drive.
  • Use On Error for workflow failures and inspect Error Message when the activity is used as an AI tool.
  • The Id of a returned folder can be used by downstream IB Drive activities that support identifying folders using By Id.

Example: Enumerate a folder​

Select the parent Folder, set Limit to 50, and iterate over Folders. Pass each current folder reference to a compatible input, or bind its Id to an IB Drive selector using By Id.

Only immediate children are returned; nested folders are not traversed automatically. An omitted Folder selects the library root. Limit caps the number returned by this execution. These activities expose no page-number output or paging token; increase the limit or organize processing by parent folder when more items are required. Do not depend on an unspecified return order. Handle normal workflow failures through On Error. When used as a tool, inspect the inherited Error Message as well as the returned collection.