Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node operation "Retrieve Agents" fetches a list of agents from the Connect Secure API. It is useful in scenarios where you need to programmatically query and retrieve agent data, such as for monitoring, reporting, or integrating agent information into other workflows or systems.

Practical examples include:

  • Retrieving all agents with specific attributes or statuses by applying query conditions.
  • Paginating through large sets of agents using skip and limit parameters.
  • Sorting the retrieved agents based on certain fields.

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 which agents to retrieve (e.g., status='active').
Skip Number of records to skip, used for pagination.
Limit Maximum number of agent records to return.
Order By Field(s) to order the results by (e.g., "name asc", "createdAt desc").

Output

The output contains JSON data representing the list of agents retrieved from the API according to the specified query parameters. Each item in the JSON array corresponds to an agent object with its associated properties as returned by the Connect Secure API.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • The node depends on the external Connect Secure API service being accessible.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Common issues:

    • Missing or invalid user ID header (X USER ID) may cause authentication failures.
    • Incorrect query conditions can result in empty responses or errors.
    • Pagination parameters (skip and limit) set incorrectly might lead to unexpected subsets of data.
    • Ordering by non-existent fields may cause API errors.
  • Error messages:

    • Authentication errors typically indicate missing or invalid credentials or headers.
    • Query parameter errors suggest malformed or unsupported query strings.
    • Network or connectivity errors imply issues reaching the Connect Secure API endpoint.

To resolve these, verify that the user ID is correctly provided, ensure query syntax matches API expectations, and confirm network access to the API.

Links and References

  • Connect Secure API documentation (refer to your organization's API docs for detailed query syntax and agent resource schema).

Discussion