Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Organization

Get agents for an organization

Return a list of agents for the organization.

Permissions

This endpoint may be impacted by the following permissions:

  • Only agents that the authenticated user has the Organization:GetAgent permission on will be returned.
get/v1/{organization}/organization/agent

Path parameters

organizationstring required

Query parameters

deprecatedboolean nullable

Whether the agent is deprecated.

Whether the agent is deprecated.

idstring[]

The IDs of the agents to filter for.

The IDs of the agents to filter for.

limitinteger

The maximum number of agents to return.

The maximum number of agents to return.

continuation_tokeninteger

The continuation token from the previous request used to retrieve the next page of agents.

The continuation token from the previous request used to retrieve the next page of agents.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded.

has_moreboolean required

Whether there are more agents to retrieve.

continuation_tokeninteger nullable required

A token to supply to the next request to retrieve the next page of agents. Only populated if has_more is True.