---
title: "Return a list of Web Tools."
method: GET
path: "/v1/voice-agents/web-tool/list"
deprecated: true
---

# Return a list of Web Tools.

`GET /v1/voice-agents/web-tool/list`

> **Deprecated.**

## Query parameters

- `voiceAgentId` string, uuid — Optional UUID of the voice agent to filter associated web tools.
- `isActive` boolean — Optional boolean indicating whether to fetch active web tools or not.
- `skip` string — Page number for pagination. Defaults to '1'.
- `take` string — Number of items to take for pagination. Defaults to '10'.
- `type` 'MCP' | 'FUNCTION' | 'WEB_TOOL' — The type of the web tool to filter.
- `search` string — A search query to filter web tools.

## Response `200`

Successful response

- ListWebToolsResponse
  - `success` boolean
  - `message` string
  - `data` object
    - `total` number — The total number of web tools over all pages.
    - `filtered` number — The filtered/returned number of web tools.
    - `items` WebToolSchema[]
      - `id` string — The unique identifier of the web tool.
      - `persistentId` string — The unique identifier of the web tool across all versions of the tool.
      - `version` number — The version of the tool.
      - `name` string — The name of the web tool.
      - `type` 'FUNCTION' | 'MCP' — The type of the web tool.
      - `userId` string — The user ID associated with the web tool.
      - `projectId` string — The project ID associated with the web tool.
      - `isActive` boolean — Indicates whether the web tool is currently active in any voice agent.
      - `async` boolean — Whether the tool runs asynchronously.
      - `description` string, nullable — A description of what the web tool does.
      - `collectionId` string — The collection ID associated with the web tool.
      - `toolSettings` object — Server configuration settings for the web tool.
        - `httpHeaders` object, nullable — HTTP headers to include in the request.
        - `pathParameters` object, nullable — Path parameters you've included in the request's URL.
        - `serverUrl` string, required — The server URL for the web tool.
        - `timeout` number, nullable — Request timeout in milliseconds.
        - `authToken` string, nullable — Authentication token for the server.
        - `methodType` string, nullable — HTTP method type for the request.
      - `params` object, nullable — Parameter schema definition for the web tool.
      - `messages` object[] — Array of message configurations for the web tool.
        - `type` string, required — The type of the message.
        - `content` string, required — The content of the message.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `500` — Server Side Error

---

[API](https://skmtc.net/tryhamsa/apis/hamsa-api.md) · [All operations](https://skmtc.net/tryhamsa/apis/hamsa-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tryhamsa/hamsa-api/versions/ecbeb5d8dc13/schema)