HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

List all Agents

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

Retrieves a paginated, sortable, and searchable list of agents.

Supports SCIM 2.0 ListResponse format with pagination, sorting, and SCIM-based filtering by agent name, ID, or external ID.

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

Examples:

  • Basic pagination: GET /Agents?page=1&limit=10
  • With sorting: GET /Agents?page=1&limit=10&sort=+displayName
  • Search by name: GET /Agents?page=1&limit=10&search=displayName eq "MyAgent"
  • Search by externalId: GET /Agents?page=1&limit=10&search=externalId eq "ext-123"
  • Combined: GET /Agents?page=1&limit=10&count=50&sort=+displayName&search=displayName eq "MyAgent"
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Query Params
integer
≄ 1
Defaults to 1

Page number (1-based)

integer
1 to 200
Defaults to 50

Number of items per page

integer
1 to 1000

Maximum total results to return (ceiling). Defaults to limit value.

string

Sort field with direction (+/-). Supported fields: displayName, id. Example: +displayName or -id

string

SCIM filter expression. Supported attributes: displayName, id, externalId.

Supported Search Operators

  • eq - Equal. The attribute and operator values must be identical for a match.

Examples: displayName eq "MyAgent", id eq "abc-123", externalId eq "ext-123"

Responses
200

List of agents retrieved successfully

400

Bad Request - Invalid pagination (CSINH1100E-CSINH1103E), search (CSINH1200E-CSINH1202E), or sort (CSINH1203E-CSINH1204E) parameters

401

Unauthorized - Authentication required

403

Forbidden - Insufficient permissions (CSINH2501E)

500

Internal Server Error (CSINH1000E)

Updated 6 days ago

Did this page help you?
Language
URL
LoadingLoading


Updated 6 days ago

Did this page help you?