Skip to main content
GET
List Agents
Read only Return the agents that belong to the authenticated organization. Use this to populate a picker in your own UI or to find an agent’s id before fetching or updating it.

When to use this

  • Agent pickers: populate a dropdown of available agents in your own tooling.
  • ID lookup: find an agent’s id by title before calling Get Agent Details or Update Agent.
  • Inventory checks: audit which agents exist in a workspace, for example before cleaning up unused ones with Delete Agent.
The response places records in data.agents without pagination metadata; the full list is returned in one response. See API pagination for how each list endpoint shapes its response.

Authorizations

Authorization
string
header
required

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

Response

Agents returned successfully.

success
enum<boolean>
required
Available options:
true
error
enum<boolean>
required
Available options:
false
statusCode
integer
required
Example:

200

message
string
required
Example:

"Success"

data
object
required
timestamp
string<date-time>
required