---
title: "List Agents"
method: GET
path: "/v1/agents/list"
tags: ["agents"]
---

# List Agents

`GET /v1/agents/list`

## Query parameters

- `page` integer
- `size` integer
- `sort_column` string, nullable
- `sort_desc` boolean, nullable

## Response `200`

Successful Response

- AgentPage
  - `items` NormalizedAgent[], required
    - `id` string, uuid, required
    - `user_id` string, uuid, required
    - `name` string, nullable
    - `prompt` union, required
      - string, uuid
      - PromptParams
        - `content` string
        - `collect_fields` CollectField[], nullable
          - `field_type` 'field_type_email', required
          - `label` string, required
          - `name` string, required
          - `description` string, nullable
        - `context_endpoint` string, nullable
        - `prompt_template` union
          - string, uuid
          - PromptTemplate
            - `id` string, uuid, required
            - `user_id` string, uuid, required
            - `label` string
            - `required_context_keys` string[], required
    - `language` 'en' | 'es' | 'de' | 'hi' | 'pt' | 'fr' | 'nl' | 'id' | 'it' | 'ja' | 'ko'
    - `actions` string[], required
    - `voice` string, uuid, required
    - `initial_message` string, nullable
    - `webhook` string, uuid, nullable
    - `vector_database` union
      - string, uuid
      - PineconeVectorDatabaseParams
        - `type` 'vector_database_pinecone', required
        - `index` string, required
        - `api_key` string, required
        - `api_environment` string, required
    - `interrupt_sensitivity` 'low' | 'high'
    - `context_endpoint` string, nullable
    - `noise_suppression` boolean
    - `endpointing_sensitivity` 'auto' | 'relaxed' | 'sensitive'
    - `ivr_navigation_mode` 'default' | 'off'
    - `conversation_speed` number
    - `initial_message_delay` number
    - `openai_model_name_override` string, nullable
    - `ask_if_human_present_on_idle` boolean
    - `openai_account_connection` union
      - OpenAIAccountConnection
        - `id` string, uuid, required
        - `user_id` string, uuid, required
        - `credentials` OpenAICredentials, required
          - `openai_api_key` string, required
        - `type` 'account_connection_openai', required
      - string, uuid
    - `run_do_not_call_detection` boolean
    - `llm_fallback` InternalLLMFallback
      - `provider` 'openai' | 'azure', required
      - `model_name` string, required
    - `deepgram_keywords` object, nullable
    - `idle_time_seconds` integer, nullable
    - `llm_temperature` number
  - `page` integer, required
  - `size` integer, required
  - `has_more` boolean, required
  - `total` integer, required
  - `total_is_estimated` boolean, required

## Other responses

- `422` — Validation Error

## Changes

- **2024-08-27** `ffca17c004e2` — 1 info
  - added the optional property `items/items/idle_time_seconds` to the response with the `200` status
- **2024-08-14** `63991d99e2e1` — 7 breaking, 11 info
  - response property `items/items/context_endpoint` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `items/items/initial_message` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `items/items/name` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `items/items/openai_model_name_override` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - …14 more
- **2024-04-19** `55ae0e0bb01f` — 2 info
  - added the required property `total` to the response with the `200` status
  - added the required property `total_is_estimated` to the response with the `200` status
- **2024-04-15** `47ab17602d64` — 1 info
  - added the optional property `items/items/name` to the response with the `200` status
- **2024-03-20** `3dbe7b5c464d` — 1 info
  - added the optional property `items/items/llm_temperature` to the response with the `200` status

[Full history](https://skmtc.dev/vocodedev/apis/vocode-hosted-api/changes/v1/agents/list/get.md)

---

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