---
title: "Query agent definitions"
method: GET
path: "/agent-repository/agent-definitions"
tags: ["Agent Definitions"]
---

# Query agent definitions

`GET /agent-repository/agent-definitions`

## Request

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

## Query parameters

- `id` string
- `name` string
- `nameLike` string
- `nameLikeIgnoreCase` string
- `key` string
- `keyLike` string
- `deploymentId` string
- `version` integer
- `latest` boolean
- `type` string
- `apiEnabled` string
- `tenantId` string
- `sort` 'id' | 'name' | 'key' | 'tenantId'

## Response `200`

successful operation

- DataResponseAgentDefinitionResponse
  - `data` AgentDefinitionResponse[]
    - `id` string, required: The unique identifier of an agent definition
    - `key` string, required: The key of the agent definition
    - `name` string, required: The name of the agent definition
    - `version` integer, required: The version of the agent definition
    - `deploymentId` string: The deployment id of the agent definition
    - `tenantId` string: The tenant id of the agent definition
    - `resourceName` string: The resource name of the agent definition
    - `description` string: The description of the agent definition
    - `type` string: The type for the agent definition
    - `apiEnabled` boolean: Whether the agent definition is enabled for API usage
  - `total` integer
  - `start` integer
  - `sort` string
  - `order` string
  - `size` integer

---

[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)