Ksaar icon

Ksaar

Consume Ksaar API

Actions13

Overview

This node integrates with the Ksaar API to interact with various resources such as Applications, Users, Workflows, and Records. Specifically for the Applications resource with the Fields operation, it retrieves the fields associated with users of a specified application.

Common scenarios where this node is beneficial include:

  • Fetching metadata about user fields in an application to dynamically build forms or validate data.
  • Integrating Ksaar user field definitions into workflows for automation or reporting.
  • Synchronizing user field structures between Ksaar and other systems.

For example, you might use this node to get all user fields of a particular application to display them in a dashboard or to prepare data mappings before importing user data.

Properties

Name Meaning
Send Headers Whether to send custom HTTP headers with the API request (true/false).
Headers If "Send Headers" is true, specify one or more HTTP headers as key-value pairs.
Application The target application from which to retrieve user fields. Can be selected from a list or entered by ID (UUID format).

Output

The node outputs a JSON array containing the user fields of the specified application. Each item in the array represents a field object with its properties as returned by the Ksaar API. The exact structure depends on the API response but typically includes field identifiers, names, types, and possibly metadata describing each user field.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Ksaar API via an API authentication token configured in n8n credentials.
  • The node uses the Ksaar API base URL https://api.ksaar.co/v1.
  • For selecting applications, it supports searching applications via a search method integrated into the node.

Troubleshooting

  • Invalid Application ID: Ensure the application ID is a valid UUID string matching the pattern [a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}. Incorrect IDs will cause validation errors.
  • API Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions to access application user fields.
  • Empty Results: If no fields are returned, confirm that the application actually has user fields defined and that the correct application is selected.
  • Custom Headers Misconfiguration: If using custom headers, ensure header names and values are correctly specified; malformed headers may cause request failures.

Links and References

Discussion