Kobana icon

Kobana

Interact with Kobana API - Quick access to common operations
Join our community

Actions215

Overview

This node interacts with the Kobana API to manage customer data under the "V1 > Customers" resource, specifically supporting the "Get Many" operation. It retrieves multiple customer records from the Kobana system, allowing users to fetch either all customers or a limited subset based on specified criteria.

Common scenarios for this node include:

  • Synchronizing customer lists from Kobana into other systems.
  • Generating reports or analytics on customer data.
  • Filtering and retrieving specific groups of customers using query parameters.

For example, a user might want to retrieve up to 50 customers who match certain filters (e.g., location, status) or fetch all customers without limit for a full export.

Properties

Name Meaning
Return All Whether to return all customer records or only up to a given limit.
Limit Maximum number of customer records to return when "Return All" is false (min 1, max 100).
Additional Fields JSON object with additional fields to include in the request (optional extra parameters).
Query Parameters JSON object with query parameters to filter or modify the list of customers returned.

Output

The output is a JSON array where each element represents a customer record retrieved from the Kobana API. Each customer object contains the fields as defined by the Kobana API response for customers.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Kobana API.
  • The node dynamically selects the API base URL depending on the environment (production or sandbox).
  • No additional external dependencies are required beyond the Kobana API access.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Exceeding API rate limits may result in errors or throttling.
    • Providing malformed JSON in "Query Parameters" or "Additional Fields" can cause request errors.
    • Requesting more than 100 records when not using "Return All" will be rejected due to limit constraints.

  • Error messages:

    • Authentication errors typically indicate invalid or expired API keys; verify and update credentials.
    • JSON parsing errors suggest incorrect formatting in input JSON fields; ensure valid JSON syntax.
    • API errors related to query parameters usually mean unsupported filters or invalid values; check the Kobana API documentation for allowed parameters.

Links and References

Discussion