Skip to main content

List Items

Lists all items in a vault.

Common Properties

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is set to true, no error will be caught when the project is executed, even if the Catch node is used.

Output

  • Vault Items - Returns an array for all the items in the vault.

Options

  • Vault - Specify the vault to list items from.

How It Works

The List Items node retrieves all items from a specified vault:

  1. Vault Selection: Retrieves vault ID from configuration or message, validates it's a valid GUID
  2. API Call: Makes GET request to vault API to retrieve all items in the vault
  3. Data Processing: Extracts item name, vault ID, and item ID for each item
  4. Output: Returns array of items with metadata (name, vault_id, item_id)

Requirements

  • Vault ID: Must be a valid GUID representing an existing vault
  • Vault Access: User must have read permissions on the vault

Error Handling

Error CodeDescriptionSolution
Core.Vault.ListItems.ErrOnCreateConfiguration parsing failedCheck node configuration
Core.Vault.ListItems.ErrOnMessageMessage parsing or API call failedVerify vault ID and API connectivity
Core.Vault.ListItems.ErrCredentialsInvalid vault credentialsVerify vault ID is valid
Core.Vault.ListItems.ErrEmptyVault ID is emptyProvide a valid vault ID
Core.Vault.ListItems.ErrInvalidVault ID is not a valid GUIDUse properly formatted GUID
Core.Vault.ListItems.ErrOutputMarshalFailed to serialize outputCheck output variable configuration

Usage Examples

Example 1: List All Items in Vault

// List all items from selected vault
// Vault: Select from dropdown
// After execution:
// msg.vaultItems = [{name: "Prod DB", vault_id: "...", item_id: "..."}, ...]

Example 2: Find Item by Name

// List items and find specific one
// After List Items execution:
msg.targetItem = msg.items.find(item => item.name === "API Token");
// Use msg.targetItem.item_id with Get Item node

Example 3: Count Items in Vault

// Count how many items are in the vault
// After execution:
msg.itemCount = msg.allItems.length;
console.log(`Vault contains ${msg.itemCount} items`);

Usage Notes

  • Returns metadata only (name, IDs) - not actual credential data
  • Use Get Item to retrieve actual credential values
  • Empty vaults return empty array (not an error)
  • Items are returned in no guaranteed order

Tips

  • Combine with loops to process multiple items
  • Use to verify item exists before Get/Set/Delete operations
  • Filter results to find items by name patterns
  • Cache list results to reduce API calls
  • Use for vault auditing and inventory management
  • Get Item - Retrieve specific items found in the list
  • List Vaults - Get list of available vaults
  • Delete Item - Delete items found in the list
  • Loop - Iterate through listed items