Cli Test icon

Cli Test

Interact with the Cli Test API

Actions3

Overview

The node "Cli Test" allows interaction with the Cli Test API, specifically supporting operations on resources such as User and Company. For the Company resource, the Get Many operation fetches multiple company records from the API. This operation is useful when you want to retrieve a list of companies, for example, to display them in a dashboard, process them in bulk, or synchronize data with another system.

A practical example would be fetching up to 50 companies to analyze their data or export them to a spreadsheet. Alternatively, you can choose to return all available companies without limit if needed.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit. Options: true (all results), false (limited results)
Limit Max number of results to return when not returning all. Accepts numbers between 1 and 100. Default is 50.

Output

The node outputs JSON data containing an array of company objects retrieved from the API. Each item in the output corresponds to a single company record with its associated fields as provided by the API response.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Cli Test API.
  • The base URL for API requests is https://fake.com.
  • The node expects the API to respond with JSON data.
  • Pagination support is built-in, allowing automatic handling of multiple pages when "Return All" is enabled.

Troubleshooting

  • Common issues:

    • Exceeding the maximum allowed limit (over 100) will likely cause an error; ensure the limit is within 1-100.
    • Not providing valid API credentials will result in authentication errors.
    • Network connectivity issues may prevent successful API calls.
  • Error messages:

    • Authentication failures typically indicate missing or invalid API keys; verify your credentials.
    • Rate limiting or quota exceeded errors suggest too many requests; consider enabling pagination or reducing request frequency.
    • Invalid parameter errors may occur if unsupported values are passed for limit or returnAll.

Links and References

Discussion