Directus (flagbit) icon

Directus (flagbit)

Consume Directus API

Actions118

Folder → List

AI-generated

Overview

This node operation lists folders from a data source, allowing users to retrieve multiple folder records with various filtering, sorting, and aggregation options. It is useful for scenarios where you need to fetch folder data for display, reporting, or further processing in workflows. For example, you can list all folders, limit the number of results, apply search filters, group results, or export the data in different formats like CSV or JSON.

Use Case Examples

  1. Retrieve all folders in a system to display in a dashboard.
  2. Fetch a limited number of folders matching a search query for a user interface.
  3. Export folder data as a CSV file for reporting purposes.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of folder results to return when not returning all.
Split Into Items Whether to output each element of an array as its own item.
JSON/RAW Parameters Whether the query and/or body parameters should be set via the value-key pair UI or JSON/RAW input.
Body Parameters Body parameters as JSON or RAW input when JSON/RAW Parameters is enabled.
Additional Fields Additional optional fields to customize the list operation, including aggregation functions, export options, filtering, sorting, grouping, and metadata.

Output

JSON

  • folders - Array of folder objects returned from the list operation.
  • exportData - Binary data of the exported file if export option is used.

Dependencies

  • An API key credential or authentication token for accessing the data source.

Troubleshooting

  • Common issues include invalid filter or aggregation syntax in JSON parameters, which can cause API errors. Verify JSON formatting and field names.
  • Errors may occur if the limit is set outside the allowed range (1-100). Ensure the limit value is within bounds.
  • Exporting data requires specifying a valid export format and file name; missing or incorrect values may cause failures.

Discussion