Skip to main content

List Agents

Retrieve a list of agents with optional filtering by organization, account, and tags.

Query Parameters
organization_id integer

The ID of the organization.

account_id integer

The ID of the account.

tags string

Tags to filter the agents in the format k1:v1,k2:v2.

Responses
200

A paged list of agents

Schema OPTIONAL
paging object OPTIONAL
limit integer OPTIONAL

The limit on the number of items to be returned.

offset integer OPTIONAL

The offset from the start of the collection.

results object[] OPTIONAL
id string OPTIONAL
name string OPTIONAL
last_heartbeat date-time OPTIONAL
runtime string OPTIONAL
version string OPTIONAL
tags object OPTIONAL
status string OPTIONAL
created_at date-time OPTIONAL
updated_at date-time OPTIONAL
capabilities object[] OPTIONAL
id string OPTIONAL
tags object OPTIONAL
status string OPTIONAL
version string OPTIONAL
configuration_id string OPTIONAL
desired_configuration_id string OPTIONAL
is_default_configuration boolean OPTIONAL
current_configuration_expires_at date-time OPTIONAL
provider string OPTIONAL
category string OPTIONAL
created_at date-time OPTIONAL
updated_at date-time OPTIONAL