List all Agents

get

https://{tenanturl}/v1.0/Agents

Retrieves a list of agents that belong to a specified tenant and match the filter criteria. Filtering and sorting are supported. Returns up to 50 agents per response.

Required Entitlements (at least one): tenantAdmin, readAgents, writeAgents, manageAgentStatus, agentOwner

Examples

List all agents: GET /Agents
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?filter=displayName eq "MyAgent"&sortBy=displayName&sortOrder=ascending

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter

string

The filter expression used to search agents. Supported attributes: displayName, id, externalId, status. Supported operator: eq.

For example, displayName eq "MyAgent" or status eq "ACTIVE".

sortBy

string

enum

The attribute used to sort the results. Supported values: displayName, id, meta.lastModified.

Allowed:

sortOrder

string

enum

Defaults to ascending

The sort order when agents are returned. Use with sortBy.

Allowed:

attributes

string

Comma-separated list of attribute names to include in the response. When specified, only these attributes are included. By default, id and schemas are always returned. Supported values: status, externalIds, displayName, description, owners, tags, meta.

For example, attributes=displayName,status,tags.

excludedAttributes

string

Comma-separated list of attribute names to exclude from the response. Cannot be used together with attributes. Supported values: status, externalIds, displayName, description, owners, tags, meta.

For example, excludedAttributes=tags.

Responses

200

List of agents retrieved successfully

400

Bad Request - Invalid search (CSINH1200E-CSINH1202E) or sort (CSINH1203E-CSINH1204E) parameters

401

Unauthorized - Authentication required

403

Forbidden - Insufficient permissions (CSINH2501E)

500

Internal Server Error (CSINH1000E)

Language

URL

Loading…