eKyte icon

eKyte

Create and retrieve data from eKyte (tasks, projects, tickets, boards, workspaces, notes, notifications)

Actions25

Insertion Order → Get Many

AI-generated

Overview

This node operation retrieves multiple person records from the eKyte API based on specified filters such as person name, document, type, and profile. It is useful for scenarios where you need to search and list persons matching certain criteria, for example, fetching all customers or suppliers with a specific name or document number.

Use Case Examples

  1. Retrieve all persons with the name 'John Doe'.
  2. Get all legal entity persons who are suppliers.
  3. Fetch persons filtered by profile type such as customers or vehicles.

Properties

Name Meaning
Base URL The base URL for the eKyte API, used as the endpoint for requests.
Person Name Filter to retrieve persons by their name (partial or full match).
Person Type Filter to specify the type of person: Any, Individual, or Legal Entity.
Person Profile Filter to specify the profile of the person to retrieve: Any, Customer, Supplier, or Vehicle.
Person Document Filter to retrieve persons by their document identifier.

Output

JSON

  • json - The JSON output contains an array of person objects matching the filter criteria, each representing a person record retrieved from the eKyte API.

Dependencies

  • Requires an API key credential for eKyte API authentication.

Troubleshooting

  • Ensure the API key credential is correctly configured and has the necessary permissions to access person data.
  • Verify that the filter parameters are correctly set; invalid or unsupported filter values may result in empty responses or errors.
  • Check network connectivity and the base URL configuration to ensure the API endpoint is reachable.
  • Common error messages include HTTP status errors with details parsed from the API response; these indicate issues such as authentication failure, invalid parameters, or server errors.

Discussion