Ksaar icon

Ksaar

Consume Ksaar API

Overview

This node integrates with the Ksaar API to manage and retrieve data related to applications, specifically focusing on workflows within an application. It allows users to fetch workflows associated with a particular application, supporting pagination and sorting options. This is useful in scenarios where you want to automate or analyze workflows tied to specific applications, such as monitoring workflow statuses, extracting workflow metadata, or integrating workflow data into other systems.

For example, you could use this node to:

  • Retrieve all workflows for a given application to display them in a dashboard.
  • Fetch workflows page by page when dealing with large datasets.
  • Sort workflows by creation or update date to process the most recent ones first.

Properties

Name Meaning
Send Headers Whether to send custom HTTP headers with the API request (true/false).
Headers Collection of custom headers to include if "Send Headers" is enabled. Each header has a name and value.
Application The target application from which to retrieve workflows. Can be selected from a list or specified by ID.
Return All Whether to return all workflows without pagination (true) or paginate results (false).
Results per Page Number of workflows to return per page when pagination is used (1 to 500).
Page Number The page number to retrieve when pagination is used (starting at 1).
Sort By Field to sort the workflows by: either "Created At" or "Updated At".

Output

The node outputs an array of JSON objects representing workflows retrieved from the Ksaar API for the specified application. Each object corresponds to a workflow and contains its details as returned by the API, such as workflow identifiers, metadata, timestamps, and other relevant properties.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Ksaar API via an API key credential configured in n8n.
  • The node uses the Ksaar API base URL https://api.ksaar.co/v1.
  • Pagination and sorting parameters are passed as query parameters to the API endpoints.

Troubleshooting

  • Invalid Application ID: If the provided application ID is not valid (does not match UUID format), the node will throw a validation error. Ensure the ID is correctly formatted.
  • API Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key credential is properly set up.
  • Pagination Issues: When "Return All" is false, ensure that "Results per Page" and "Page Number" are set correctly to avoid empty or incomplete results.
  • Empty Results: If no workflows are returned, confirm that the application actually has workflows and that the correct application ID is used.
  • Custom Headers Misconfiguration: If "Send Headers" is enabled but headers are incorrectly specified, requests may fail. Double-check header names and values.

Links and References

Discussion