Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node interacts with the "Connect Secure" API to retrieve company mapping data. Specifically, the "Retrieve Company Mappings" operation fetches a list of company mappings based on optional filtering, pagination, and sorting parameters. This is useful in scenarios where you need to integrate or synchronize company-related data from an external system into your workflows, such as syncing CRM data, generating reports, or automating business processes that depend on company information.

Practical examples:

  • Fetching a filtered list of company mappings matching certain criteria.
  • Paginating through large sets of company mappings by skipping and limiting records.
  • Ordering the retrieved company mappings by specific fields for sorted output.

Properties

Name Meaning
X USER ID User identifier required for authentication or tracking purposes in the API request header.
Condition Query condition string to filter the company mappings returned by the API.
Skip Number of records to skip (offset) for pagination purposes.
Limit Maximum number of records to return (page size).
Order By Field(s) by which to order the returned company mappings.

Output

The node outputs JSON data representing the retrieved company mappings. The structure typically includes an array of company mapping objects, each containing details as defined by the external API's response schema. The exact fields depend on the API but generally include identifiers and mapping attributes relevant to companies.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • Depends on the external Connect Secure service being accessible.
  • The node uses an OpenAPI specification internally to define operations and properties.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Missing or invalid X USER ID: The API requires the "X USER ID" header; ensure it is provided and valid to avoid authentication errors.
  • Invalid query conditions: Malformed or unsupported query strings in the "Condition" property may cause the API to reject the request.
  • Pagination issues: Setting "Skip" or "Limit" incorrectly (e.g., negative numbers) might result in errors or unexpected results.
  • Ordering errors: Using invalid field names in "Order By" can lead to API errors or ignored ordering.
  • API connectivity problems: Network issues or incorrect API credentials will prevent successful data retrieval.

To resolve these, verify all input parameters, ensure correct API credentials, and consult the external API documentation for valid query syntax and supported fields.

Links and References

Discussion