Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node operation, Retrieve Companies, is designed to fetch a list of companies from the Connect Secure API. It allows users to query company data with flexible filtering, pagination, and sorting options. This operation is useful in scenarios where you need to integrate company information into workflows, such as syncing company records, generating reports, or enriching customer data.

Practical examples include:

  • Retrieving all companies that meet certain criteria (e.g., location, industry) for marketing campaigns.
  • Paginating through large sets of company data to process or analyze them incrementally.
  • Sorting companies by name or creation date to display ordered lists in dashboards.

Properties

Name Meaning
X USER ID User Id header required for authentication or identification purposes in the API call.
Condition Query condition string to filter companies based on specific criteria.
Skip Number of records to skip, used for pagination.
Limit Maximum number of company records to retrieve.
Order By Field(s) to order the results by, e.g., "name asc" or "createdAt desc".

Output

The output of this operation is a JSON array containing company objects retrieved from the API. Each object represents a company with its associated fields as returned by the Connect Secure API. The exact structure depends on the API response but typically includes identifiers, names, and other company attributes.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • The node uses the Connect Secure API endpoint defined in its OpenAPI specification.
  • Proper configuration of the API credentials within n8n is necessary for successful requests.

Troubleshooting

  • Missing or invalid X USER ID: Since the X USER ID header is required, omitting it or providing an incorrect value will likely cause authentication errors or request failures. Ensure this property is set correctly.
  • Invalid query conditions: Malformed or unsupported query strings in the Condition property may result in API errors or empty responses. Validate the syntax according to the API's query language.
  • Pagination issues: Setting Skip or Limit incorrectly (e.g., negative numbers) might cause unexpected results or errors. Use non-negative integers.
  • Order By format errors: Incorrectly formatted Order By values can lead to sorting errors. Follow the API's expected format for ordering fields.

Links and References

Discussion