Directus (flagbit) icon

Directus (flagbit)

Consume Directus API

Actions100

Overview

The Folder List operation in this node retrieves a collection of folder records from an external service. It supports fetching all folders or limiting the number of results, applying filters, sorting, grouping, and aggregation functions. This operation is useful when you need to programmatically access and analyze folder data, for example, to display folder lists, generate reports, or export folder metadata.

Common scenarios include:

  • Listing all folders available in a system.
  • Retrieving a subset of folders based on search criteria or filters.
  • Exporting folder data in CSV, JSON, or XML formats.
  • Performing aggregate calculations like counting folders or finding averages grouped by certain fields.

Properties

Name Meaning
Return All Whether to return all folder results or only up to a specified limit.
Limit Maximum number of folder results to return (used if "Return All" is false).
Split Into Items Whether to output each element of an array as its own item.
JSON/RAW Parameters Whether to set query/body parameters via UI key-value pairs or directly as JSON/RAW input.
Body Parameters Raw JSON or RAW body parameters for the request (used if JSON/RAW Parameters is true).
Additional Fields Collection of optional additional parameters:
- Aggregate Aggregation functions to perform calculations on folder data, such as average, count, max, min, sum, etc.
- Binary Property for Export Data Name of the binary property where exported file data will be saved.
- Deep (JSON) Nested relational dataset parameters for deep querying.
- Export Format to save API response to a file: CSV, JSON, or XML.
- File Name for Export Data Filename (without extension) for the exported data file.
- Fields Comma-separated list of fields to control which folder fields are returned.
- Filter (JSON) JSON filter conditions to select specific folders.
- Group By Field(s) to group results by for aggregation purposes.
- Meta Metadata fields to include in the response.
- Offset Number of items to skip when fetching data (for pagination).
- Search Search query string to filter folders containing the given text in any field.
- Sort CSV of fields to sort the returned folders by; prefix with "-" for descending order, "?" for random sorting.

Output

The node outputs JSON data representing the list of folders retrieved according to the specified parameters. The structure typically includes an array of folder objects with their respective fields as requested.

If the export option is used, the node outputs the API response saved as a binary file in the chosen format (CSV, JSON, or XML). The binary data is stored under the specified binary property name, allowing downstream nodes to handle the exported file.

Dependencies

  • Requires connection to an external API/service that manages folders.
  • Needs appropriate API authentication credentials configured in n8n to authorize requests.
  • Supports exporting data, so file handling capabilities within n8n are utilized.

Troubleshooting

  • Issue: No folders returned or fewer than expected.

    • Cause: Filters, search queries, or limits may restrict results.
    • Resolution: Verify filter and search parameters; increase limit or enable "Return All".

  • Issue: Exported file is empty or corrupted.

    • Cause: Incorrect export format or file naming issues.
    • Resolution: Ensure export format matches expected content type; verify file name does not contain invalid characters.

  • Issue: API authentication errors.

    • Cause: Missing or invalid API credentials.
    • Resolution: Check and update API key or authentication token in n8n credentials.

  • Issue: Invalid JSON in Body Parameters or Filter.

    • Cause: Malformed JSON input.
    • Resolution: Validate JSON syntax before saving.

Links and References

This summary is based solely on static analysis of the provided source code and property definitions.

Discussion