List published Managed Agents

GET 
/agent-studio/managed-agents

Returns only Managed Agents with a published production version in the authorized sub-account.

Request

Version stringrequired

API version.

Available optionsv3

locationId stringrequired

Authorized sub-account ID.

Possible values: <= 256 characters

skip integer

Number of matching agents to skip.

Possible values: >= 0

Default value:0

limit integer

Maximum number of agents to return.

Possible values: >= 1 and <= 100

Default value:25

query string

Case-insensitive name or description search.

Possible values: <= 256 characters

application/json

Published Managed Agents retrieved.

application/json

Schema

Schema

agentsobject[]required

Published Managed Agents on this page.

totalintegerrequired

Total number of matching published agents.

Possible values: >= 0

skipintegerrequired

Number of matching agents skipped.

Possible values: >= 0

limitintegerrequired

Maximum number of agents returned per page.

Possible values: >= 1 and <= 100

hasMorebooleanrequired

Whether another page of results is available.

Example (auto)

{
  "agents": [
    {
      "id": "027ee957-ae94-40ad-89a3-b25c985f729b",
      "name": "Lead Qualifier",
      "description": "Qualifies inbound leads and books appointments.",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "publishedVersionId": "Ver1K8sSF2nC7al5InWz"
    }
  ],
  "total": 3,
  "skip": 0,
  "limit": 25,
  "hasMore": false
}