---
title: "List agents"
method: GET
path: "/controlplane/agent"
tags: ["Agent"]
---

# List agents

`GET /controlplane/agent`

Lists agents within an organization.

## Query parameters

- `organization_id` integer
- `account_id` integer
- `nrn` string
- `status` 'active' | 'inactive'
- `tags` string

## Response `200`

The list of agents matching the query.

- AgentListResponse
  - `paging` object, required
    - `offset` integer, required — The starting point for pagination. Defaults to 0 if not provided.
    - `limit` integer, required — The maximum number of results to return per page. The maximum allowed value is 200.
  - `results` Agent[], required
    - `id` string, required — A system-wide unique ID for the agent.
    - `name` string, nullable, required — The name of the agent.
    - `nrns` string[] — List of NRNs the agent is authorized to operate on, derived from the API key permissions.
    - `last_heartbeat` string, date-time, required — The ISO-8601 UTC timestamp of the last heartbeat from the agent.
    - `runtime` string, required — The runtime the agent runs on, for example, `k8s` or `host`.
    - `version` string, required — The version of the agent.
    - `tags` object, required — Object containing key-value pairs representing tags to be matched for applying the configuration.
    - `status` 'active', required — The status of the agent.
    - `created_at` string, date-time, required — The ISO-8601 UTC timestamp of when the agent was created.
    - `updated_at` string, date-time, nullable — The ISO-8601 UTC timestamp of when the agent was last updated.
    - `capabilities` Capability[]
      - `id` string — A system-wide unique ID for the capability.
      - `tags` object — Object containing key-value pairs representing tags to be matched for applying the capability.
      - `status` 'active' — The status of the capability.
      - `version` string — The version of the capability.
      - `configuration_id` string — The ID of the configuration.
      - `desired_configuration_id` string — The ID of the desired configuration.
      - `is_default_configuration` true | false — Defines whether this capability is the default configuration.
      - `current_configuration_expires_at` string, date-time, nullable — The expiration date of the current configuration.
      - `provider` string — The provider of the capability.
      - `category` string — The category of the capability.
      - `created_at` string, date-time — The ISO-8601 UTC timestamp of when the capability was created.
      - `updated_at` string, date-time, nullable — The ISO-8601 UTC timestamp of when the capability was last updated.

## Other responses

- `4XX` — Client error responses due to invalid input or missing parameters.
- `5XX` — Server error responses indicating an issue on the API side.

---

[API](https://skmtc.dev/nullplatform/apis/nullplatform-api.md) · [All operations](https://skmtc.dev/nullplatform/apis/nullplatform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nullplatform/nullplatform-api/revisions/1c4ea154b159/schema)