> ## Documentation Index > Fetch the complete documentation index at: https://docs.tryhamsa.com/llms.txt > Use this file to discover all available pages before exploring further. # List Web Tools > Retrieves a paginated list of web tools with optional filtering by project, status, type, collection, and search term. ## OpenAPI ````yaml /api-reference/openapi.json get /v2/voice-agents/web-tool/list openapi: 3.0.1 info: title: Hamsa API description: Trying out our transcription and media-to-text APIs license: name: MIT version: 1.0.0 servers: - url: https://api.tryhamsa.com security: [] paths: /v2/voice-agents/web-tool/list: get: summary: List Web Tools description: >- Retrieves a paginated list of web tools with optional filtering by project, status, type, collection, and search term. parameters: - in: query name: isActive required: false description: Filter by activation status schema: type: boolean example: true - in: query name: returnUncategorized required: false description: >- Return only web tools that are not in any collection. Cannot be used with collectionId. schema: type: boolean example: false - in: query name: voiceAgentId required: false description: The unique identifier of the voice agent to filter by schema: type: string format: uuid example: 48f7656f-098b-4c43-b165-7cfd2cc8ac30 - in: query name: skip required: false description: Page number for pagination (1-based) schema: type: integer default: 1 minimum: 1 example: 1 - in: query name: take required: false description: Number of items per page schema: type: integer default: 10 minimum: 1 example: 10 - in: query name: search required: false description: Search web tools by name schema: type: string example: Weather API - in: query name: type required: false description: Filter by web tool type schema: type: string enum: - FUNCTION - MCP - WEB_TOOL example: FUNCTION - in: query name: collectionId required: false description: >- Filter by collection ID. Cannot be used with returnUncategorized=true. schema: type: string format: uuid example: 48f7656f-098b-4c43-b165-7cfd2cc8ac30 responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListWebToolsResponseV2' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorSchema' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchema' '500': description: Server Side Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchema' security: - ApiKeyAuth: [] components: schemas: ListWebToolsResponseV2: type: object properties: success: type: boolean example: true data: type: object properties: items: type: array items: $ref: '#/components/schemas/WebToolData' total: type: integer description: Total number of web tools matching the criteria example: 25 filtered: type: integer description: Number of web tools after applying filters example: 10 ErrorSchema: type: object properties: code: type: integer message: type: string WebToolData: type: object properties: id: type: string format: uuid description: The unique identifier of the web tool example: 48f7656f-098b-4c43-b165-7cfd2cc8ac30 persistentId: type: string format: uuid nullable: true description: The persistent ID used for versioning example: 48f7656f-098b-4c43-b165-7cfd2cc8ac30 version: type: integer description: The version number of the web tool example: 1 name: type: string description: The name of the web tool example: Get Weather Data type: type: string enum: - FUNCTION - MCP - WEB_TOOL description: The type of web tool example: FUNCTION userId: type: string format: uuid description: The ID of the user who created the tool example: 48f7656f-098b-4c43-b165-7cfd2cc8ac30 projectId: type: string format: uuid description: The ID of the project example: 48f7656f-098b-4c43-b165-7cfd2cc8ac30 isActive: type: boolean description: Whether the web tool is active example: true async: type: boolean description: Whether the tool runs asynchronously example: false description: type: string nullable: true description: Description of the web tool example: Fetches current weather data for a given location collectionId: type: string format: uuid nullable: true description: The collection ID if grouped example: 48f7656f-098b-4c43-b165-7cfd2cc8ac30 toolSettings: type: object nullable: true description: Tool server settings (null for WEB_TOOL type) properties: httpHeaders: type: object nullable: true description: Custom HTTP headers pathParameters: type: object nullable: true description: URL path parameters serverUrl: type: string nullable: true description: The server endpoint URL timeout: type: number nullable: true description: Request timeout in seconds authToken: type: string nullable: true description: Authentication token methodType: type: string nullable: true description: HTTP method type params: type: object nullable: true description: The parameters schema in OpenAPI format messages: type: array description: Messages to display during tool execution items: $ref: '#/components/schemas/WebToolMessage' WebToolMessage: type: object required: - type - content properties: type: type: string enum: - REQUEST_START - REQUEST_COMPLETE description: The type of message. Each type can only appear once. example: REQUEST_START content: type: string description: The message content to display example: Fetching weather data... securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: >- Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token ' ````