Ksaar icon

Ksaar

Consume Ksaar API

Actions13

Overview

This node interacts with the Ksaar API to retrieve records from workflows within a specified application. Specifically, the "Get Records" operation under the "Workflows" resource fetches data records associated with a selected workflow. It supports filtering, sorting, and pagination, allowing users to tailor the data retrieval to their needs.

Common scenarios where this node is beneficial include:

  • Extracting all or filtered records from a particular workflow for reporting or analysis.
  • Integrating workflow data into other systems by fetching records programmatically.
  • Automating data synchronization tasks where workflow records need to be processed or transferred.

For example, a user might want to get all records from a workflow that tracks customer feedback, filter them by a specific field value (e.g., feedback status), and then use that data in another automation step.

Properties

Name Meaning
Send Headers Whether to send custom HTTP headers with the API request.
Headers If "Send Headers" is enabled, specify one or more HTTP headers as key-value pairs to include in the request.
Application The target application containing the workflow. Can be selected from a list or provided as an ID.
Workflow The specific workflow from which to retrieve records. Can be selected from a list or provided as an ID.
Sort By Field by which to sort the returned records. Options: "Created At" or "Updated At".
Return All Whether to return all matching records without pagination (true) or paginate results (false).
Filters When returning all records, optional filters can be applied. Each filter specifies a field and a value; only records matching these criteria are included.
Results per Page Number of records to return per page when pagination is used. Minimum 1, maximum 500.
Page Number The page number to retrieve when pagination is used. Minimum 1.

Output

The node outputs an array of JSON objects representing the retrieved records from the specified workflow. Each record object contains fields corresponding to the workflow's data schema, including any metadata such as creation or update timestamps.

If filters are applied, only records matching those filters appear in the output. When pagination is used, the output corresponds to the requested page and number of results per page.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Ksaar API via an API authentication token configured in n8n credentials.
  • The node uses internal helper functions to perform HTTP requests to Ksaar endpoints.
  • The user must have access rights to the specified application and workflow within Ksaar.

Troubleshooting

  • Invalid IDs: The node validates UUID format for application and workflow IDs. Providing invalid IDs will cause errors. Ensure IDs match the expected pattern.
  • Empty Results: If no records are returned, verify that the workflow contains data and that any applied filters are correct.
  • Pagination Issues: When "Return All" is false, ensure "Results per Page" and "Page Number" are set correctly to avoid missing data.
  • API Authentication Errors: Check that the API key credential is valid and has sufficient permissions.
  • Filter Misconfiguration: Filters require both a valid field and a value. Incorrect field selection or empty values may result in unexpected results or no data.

Links and References

Discussion