Directus (flagbit) icon

Directus (flagbit)

Consume Directus API

Actions118

Role → List

AI-generated

Overview

This node operation lists roles from a data source, allowing users to retrieve role information with various filtering, sorting, and aggregation options. It is useful for scenarios where you need to fetch role data for user management, reporting, or integration with other systems.

Use Case Examples

  1. Retrieve all roles without limit to get a complete list of roles.
  2. Fetch a limited number of roles (e.g., 50) for pagination or performance reasons.
  3. Apply filters and sorting to get roles matching specific criteria, such as roles created after a certain date or sorted by name.
  4. Use aggregation functions to get counts or averages related to roles, such as counting the number of roles or finding the maximum value of a field.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of 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, used when JSON/RAW Parameters is enabled.
Additional Fields Additional optional fields to customize the query, including aggregation functions, export options, filtering, sorting, grouping, and metadata.

Output

JSON

  • roles - Array of role 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 roles data source.

Troubleshooting

  • Ensure the API credentials are correctly configured to avoid authentication errors.
  • If using JSON/RAW parameters, validate the JSON syntax to prevent parsing errors.
  • When setting limits, ensure the value is within the allowed range (1 to 100) to avoid validation errors.
  • If no roles are returned, check the filter and search parameters to ensure they match existing data.

Discussion