Hanzo
OpenapiTeam

Returns the caller org's bot members — the org's agents projected as the…

Returns the caller org's bot members — the org's agents projected as the workspace Employees they become, each with the member account uuid and Person…

GET /v1/team/bots

Addresshttps://api.hanzo.ai/v1/team/bots
MethodGET
Operationget_team_bots
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the caller org's bot members — the org's agents projected as the workspace Employees they become, each with the member account uuid and Person reference the roster addresses it by. An agents subsystem that is not mounted answers an empty list, never an error.

Request

GET /v1/team/bots takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200botRosterok

200 body — 6 fields.

FieldInTypeAlwaysDescription
botsbodybotMember[]Bots is every agent of the caller's org, projected as a workspace member.
bots[].activebodybooleanActive is whether the agent projects as a LIVE workspace member, derived from its registry status: empty, "active" and "ready" are live, anything else…
bots[].idbodystringthe agent id
bots[].namebodystringdisplay name
bots[].personRefbodystringthe projected Person _id
bots[].userIdbodystringderived member account uuid (personUuid)

Failure carries the platform error shape — see Errors.

Examples

hanzo team bots get

Team API · All Hanzo APIs · Interactive reference

How is this guide?

On this page