Sapience icon

Sapience

Sapience API integration

Agent → Get Agents List

AI-generated

Summary

Get Agents List

Inputs

  • statusFilter — Optional status filter (status_filter query parameter). Default: 'active'.
  • forceSync — Whether to fetch from the vendor before reading from the database (force_sync query parameter). Default: false.

Output shape

Array of agent objects from the API response data field. If data is missing, returns an empty array.

When used in a workflow, each agent in the returned array is emitted as a separate output item.

Examples

Example 1: List all active agents

Set Resource: Agent, Operation: Get Agents List, leave defaults.

Example 2: Force a fresh sync and include inactive agents

Set Status Filter to 'all' (or any status) and enable Force Sync.

Links

Discussion