Ksaar icon

Ksaar

Consume Ksaar API

Actions13

Overview

This node interacts with the Ksaar API to perform various operations related to Applications, specifically here focusing on the Email operation under the Applications resource. The Email operation retrieves user information by their email address within a specified application.

Typical use cases include:

  • Fetching user details based on their email in a particular application.
  • Automating workflows that require user data lookup by email.
  • Integrating Ksaar user data retrieval into broader automation processes.

For example, you might use this node to get detailed user info when a new email arrives or when processing form submissions linked to specific users.

Properties

Name Meaning
Send Headers Boolean flag to indicate whether custom HTTP headers should be sent with the request.
Headers Collection of custom HTTP headers (key-value pairs) to send if "Send Headers" is enabled.
Application Select or specify the ID of the application in which to search for the user by email.
User Email The email address of the user to retrieve within the selected application.

Output

The output is a JSON array containing the user data retrieved from the Ksaar API for the given email and application. The structure corresponds to the user object as returned by the Ksaar API, typically including user attributes such as ID, name, email, and other metadata associated with the user in the application.

No binary data output is involved in 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.
  • The "Application" property depends on a resource locator that supports searching and selecting applications from Ksaar.
  • Proper permissions and API access rights are necessary to query user data by email.

Troubleshooting

  • Invalid Application ID: Ensure the application ID is correctly formatted as a UUID. The node validates this format and will error if invalid.
  • User Not Found: If no user matches the provided email in the specified application, the API may return an empty result or error. Verify the email and application selection.
  • API Authentication Errors: Check that the API key credential is valid and has sufficient permissions.
  • Custom Headers Misconfiguration: If "Send Headers" is enabled but headers are incorrectly set, requests may fail. Double-check header names and values.
  • Network Issues: Connectivity problems to the Ksaar API endpoint can cause failures; verify network access.

Links and References

Discussion