Dart icon

Dart

Dart streamlines project management so your team can get back to work that matters.
Join our community

Actions18

Overview

The node provides functionality to list documents ("Docs") from the Dart project management system. It allows users to retrieve a paginated list of documents with various filtering and sorting options. This is useful for workflows that need to process, analyze, or display document metadata from Dart, such as generating reports, syncing documents to other systems, or automating document-based notifications.

Practical examples:

  • Retrieve the first 50 documents in a specific folder to sync them with another database.
  • Search for documents containing certain keywords in their title or text.
  • List documents ordered by creation date to monitor recent additions.

Properties

Name Meaning
Limit Max number of results to return (number between 1 and 200). Controls pagination size.
Offset The initial index from which to return the results (minimum 0). Used for pagination to skip a number of documents.
Filters A collection of optional filters to refine the document list:
- Folder Filter documents by folder name (string).
- Folder ID Filter documents by folder identifier (string).
- IDs Filter documents by specific document IDs (string).
- In Trash Boolean flag to include documents that are in trash (default true).
- Order JSON value specifying ordering criteria. Possible values include: order, -order, created_at, -created_at, updated_at, -updated_at, title, -title. The minus prefix indicates descending order.
- Search Search string to filter documents by title, text, or folder title.
- Text Filter documents by matching text content (string).
- Title Filter documents by matching title (string).

Output

The node outputs a JSON array of document objects matching the query parameters. Each object represents a document with its metadata fields such as ID, title, folder, creation date, update date, and possibly other relevant document attributes.

If the node supports binary data output (not indicated here), it would typically represent document file contents or attachments, but this is not evident from the provided code and properties.

Dependencies

  • Requires an API key credential for authenticating with the Dart service.
  • Needs the base URL of the Dart API configured in credentials.
  • The node sends HTTP requests to the Dart API endpoint to fetch document data.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Exceeding the maximum limit (200) may result in errors or truncated results.
    • Using invalid filter values (e.g., non-existent folder IDs) may return empty results.
  • Error messages:
    • Authentication errors indicate problems with the API key or URL configuration.
    • Validation errors may occur if numeric inputs are out of allowed ranges.
    • Network errors suggest connectivity issues with the Dart API endpoint.

To resolve these, verify credentials, ensure input values respect constraints, and check network access.

Links and References

Discussion