Flow AgentsVersion: v3

List Agents

GET/agent-studio/agent

Lists all active agents for the specified location. locationId is required parameter to ensure optimal performance. Supports pagination using limit and offset. Optionally filter by isPublished=true to return only agents with a published production version.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:agent-studio.readonly

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Query Parameters

locationIdstringrequired

Location (sub-account) ID to list agents for

Example:C2QujeCh8ZnC7al2InWR

isPublishedstring

Optional filter to return only agents with a published production version

Example:true

limitstringrequired

Maximum number of agents to return (pagination page size)

Example:20

offsetstringrequired

Number of agents to skip before collecting results (pagination offset)

Example:0

sourcestring

Origin channel attributed to this read for auditing (e.g. public_api, internal)

Example:api

Response

application/json

Agents retrieved successfully

successbooleanrequired

Success status

Example:true

messagestringrequired

Response message

Example:Agents retrieved successfully

agentsobject[]required

List of agents with metadata

paginationobjectrequired

Pagination metadata