---
title: "Query Agent connections"
method: GET
path: "/agent-management/agent-connections"
tags: ["Agent Connections"]
---

# Query Agent connections

`GET /agent-management/agent-connections`

## Request

- Base URL: `http://localhost:8090/agent-api`
- URL: `http://localhost:8090/agent-api/agent-management/agent-connections`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/flowable/apis/flowable-agent-engine-rest-api/docs/agent-management/agent-connections/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `id` string
- `key` string
- `keyLikeIgnoreCase` string
- `order` string
- `size` integer
- `sort` string
- `start` integer
- `tenantId` string
- `tenantIdLike` string

## Response `200`

Indicates that the request was successful

- DataResponseAgentConnectionResponse
  - `data` AgentConnectionResponse[]
    - `id` string: Internal id of the Agent connection
    - `key` string, required: Stable key the agent references
    - `name` string: Human-readable display name
    - `connectivity` object: Provider connectivity payload (vendor-specific shape).
    - `tenantId` string: Tenant the connection belongs to
    - `updateTime` integer: When the connection was last updated
    - `updaterId` string: User that last updated the connection
  - `total` integer
  - `start` integer
  - `sort` string
  - `order` string
  - `size` integer

## Other responses

- `400`: Indicates the request parameters are incomplete or contain illegal values.
- `403`: Indicates that the user doing the request does not have the required permissions for viewing Agent connections

---

[API](https://skmtc.dev/flowable/apis/flowable-agent-engine-rest-api.md) - [All operations](https://skmtc.dev/flowable/apis/flowable-agent-engine-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/flowable/apis/flowable-agent-engine-rest-api/revisions/54fc1189496f?raw)
