get
https://{tenanturl}/v1.0/Agents
Retrieves a list of agents that belong to a specified tenant and match the filter criteria. Pagination, filtering, and sorting are supported. A maximum of 1000 records are returned.
Required Entitlements (at least one): tenantAdmin, readAgents, writeAgents, manageAgentStatus, agentOwner
Examples
- List all agents:
GET /Agents - Paginate results:
GET /Agents?startIndex=51&count=50 - Filter by name:
GET /Agents?filter=displayName eq "MyAgent" - Filter by ID:
GET /Agents?filter=id eq "550e8400-e29b-41d4-a716-446655440000" - Filter by external ID:
GET /Agents?filter=externalId eq "ext-123" - Sort by name:
GET /Agents?sortBy=displayName&sortOrder=ascending - Combined:
GET /Agents?startIndex=1&count=25&filter=displayName eq "MyAgent"&sortBy=displayName&sortOrder=ascending
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests⊠| |||
LoadingâŠ
200List of agents retrieved successfully
400Bad Request - Invalid pagination (CSINH1100E-CSINH1103E), search (CSINH1200E-CSINH1202E), or sort (CSINH1203E-CSINH1204E) parameters
401Unauthorized - Authentication required
403Forbidden - Insufficient permissions (CSINH2501E)
500Internal Server Error (CSINH1000E)
