Ksaar icon

Ksaar

Consume Ksaar API

Overview

This node interacts with the Ksaar API to manage and retrieve data related to Applications, specifically focusing on the "Users" operation within the "Applications" resource. It allows users to fetch paginated lists of users associated with a specific application, sorted by creation or update date.

Common scenarios where this node is beneficial include:

  • Retrieving user lists for a given application to analyze or process user data.
  • Automating workflows that require user information from an application.
  • Integrating Ksaar user data into other systems or dashboards.

For example, you can use this node to get the first 100 users of an application sorted by their creation date, or paginate through all users to synchronize them with another service.

Properties

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

Output

The node outputs a JSON array containing user objects retrieved from the Ksaar API for the specified application. Each object represents a user with fields as returned by the API, typically including user identifiers, metadata, timestamps, and other user-related information.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Ksaar API.
  • The node uses the base URL https://api.ksaar.co/v1 for all API calls.
  • No additional external dependencies are required beyond the configured API authentication.

Troubleshooting

  • Empty results or no users returned:
    Ensure the correct application is selected and that it contains users. Verify pagination parameters (page number and results per page) are set correctly.

  • Invalid Application ID error:
    The application ID must match the UUID format (e.g., 4ba0bc35-3ace-4f1d-a877-b5a94619029d). Check the input for typos or incorrect formatting.

  • API authentication errors:
    Confirm that the API key credential is valid and has sufficient permissions to access user data for the application.

  • Rate limiting or timeout errors:
    If retrieving large datasets, consider using pagination with smaller page sizes or implement retry logic in your workflow.

Links and References


If you need details on other operations or resources, feel free to ask!

Discussion