Skip to main content
GET
/
v2
/
voice-agents
/
web-tool
/
list
List Web Tools
curl --request GET \
  --url https://api.tryhamsa.com/v2/voice-agents/web-tool/list \
  --header 'Authorization: <api-key>'
{
  "success": true,
  "data": {
    "items": [
      {
        "id": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
        "persistentId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
        "version": 1,
        "name": "Get Weather Data",
        "type": "FUNCTION",
        "userId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
        "projectId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
        "isActive": true,
        "async": false,
        "description": "Fetches current weather data for a given location",
        "collectionId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
        "toolSettings": {
          "httpHeaders": {},
          "pathParameters": {},
          "serverUrl": "<string>",
          "timeout": 123,
          "authToken": "<string>",
          "methodType": "<string>"
        },
        "params": {},
        "messages": [
          {
            "type": "REQUEST_START",
            "content": "Fetching weather data..."
          }
        ]
      }
    ],
    "total": 25,
    "filtered": 10
  }
}

Authorizations

​
Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Query Parameters

​
isActive
boolean

Filter by activation status

Example:

true

​
returnUncategorized
boolean

Return only web tools that are not in any collection. Cannot be used with collectionId.

Example:

false

​
voiceAgentId
string<uuid>

The unique identifier of the voice agent to filter by

Example:

"48f7656f-098b-4c43-b165-7cfd2cc8ac30"

​
skip
integer
default:1

Page number for pagination (1-based)

Required range: x >= 1
Example:

1

​
take
integer
default:10

Number of items per page

Required range: x >= 1
Example:

10

​
search
string

Search web tools by name

Example:

"Weather API"

​
type
enum<string>

Filter by web tool type

Available options:
FUNCTION,
MCP,
WEB_TOOL
Example:

"FUNCTION"

​
collectionId
string<uuid>

Filter by collection ID. Cannot be used with returnUncategorized=true.

Example:

"48f7656f-098b-4c43-b165-7cfd2cc8ac30"

Response

Successful response

​
success
boolean
Example:

true

​
data
object