> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gnani.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List Agents

> Retrieve a paginated list of agents with optional search filtering

## Overview

Retrieve a paginated list of all voice agents belonging to your organization. Results can be filtered by agent name and paginated for easy navigation through large collections.

## Required Permission

`agents`

## Query Parameters

| Name       | Type    | Required | Description                                                                                          |
| ---------- | ------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `search`   | string  | No       | Filter results by agent name (partial match).                                                        |
| `pageNo`   | integer | No       | Page number to retrieve. Default: `1`. Must be `1` or greater — sending `pageNo=0` returns HTTP 500. |
| `pageSize` | integer | No       | Number of agents per page. Default: `10`.                                                            |

## Example cURL

```bash theme={null}
curl "https://api.inya.ai/platform/v1/agents?search=support&pageNo=1&pageSize=10" \
  -H "x-api-key: <your_api_key>"
```

## Response

### Success (200)

```json theme={null}
{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Agents retrieved successfully",
  "response": {
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 1,
    "totalPages": 1,
    "bots": [
      {
        "botId": "fb79920229d144608ebf665a10e50275",
        "botName": "Support Agent",
        "botInfo": {
          "botDescription": "Handles inbound customer support calls.",
          "botLanguage": ["en-IN"],
          "botRegion": "asia",
          "botTimezone": "Asia/Kolkata"
        },
        "createdAt": "2026-04-01T10:00:00Z",
        "updatedAt": "2026-07-01T12:00:00Z"
      }
    ]
  }
}
```

## Response Fields

| Field              | Type    | Description                                                                                |
| ------------------ | ------- | ------------------------------------------------------------------------------------------ |
| `pageNo`           | integer | Current page number.                                                                       |
| `pageSize`         | integer | Number of results per page.                                                                |
| `totalCount`       | integer | Total number of agents in your organization.                                               |
| `totalPages`       | integer | Total number of pages available.                                                           |
| `bots[].botId`     | string  | Unique agent identifier.                                                                   |
| `bots[].botName`   | string  | Agent display name.                                                                        |
| `bots[].botInfo`   | object  | Summary object containing `botDescription`, `botLanguage`, `botRegion`, and `botTimezone`. |
| `bots[].createdAt` | string  | ISO 8601 timestamp of when the agent was created.                                          |
| `bots[].updatedAt` | string  | ISO 8601 timestamp of the most recent update.                                              |

## Use Cases

* Viewing all agents in your organization
* Searching for a specific agent by name before retrieving its full configuration
* Building an agent management dashboard with pagination

<Tip>
  Use the `search` parameter to quickly locate a specific agent by name instead of paginating through all results.
</Tip>

<Note>
  Save the `requestId` from every response. You will need it if you contact Inya support to trace a specific request.
</Note>


## OpenAPI

````yaml GET /v1/agents
openapi: 3.0.3
info:
  title: Platform Agents API
  description: API endpoints for creating, managing, and interacting with voice agents
  version: 2.1.0
servers:
  - url: https://api.inya.ai/platform
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Agents
    description: Agent management operations
  - name: AgentFAQ
    description: Agent FAQ management
  - name: AgentCallTriggers
    description: Outbound call triggers
  - name: ChatSDK
    description: Chat Widget configuration
  - name: Conversations
    description: Conversation logs, statistics, and audio
paths:
  /v1/agents:
    get:
      tags:
        - Agents
      summary: List all agents
      description: >-
        Retrieve a paginated list of all agents belonging to your organization.
        Results can be filtered by name.
      operationId: listAgents
      parameters:
        - name: search
          in: query
          description: Filter results by agent name (partial match)
          required: false
          schema:
            type: string
        - name: pageNo
          in: query
          description: Page number to retrieve. Default 1.
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: pageSize
          in: query
          description: Number of agents per page. Default 10.
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
      responses:
        '200':
          description: Agents retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
              examples:
                success:
                  value:
                    status: success
                    requestId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    message: Agents retrieved successfully
                    response:
                      pageNo: 1
                      pageSize: 10
                      totalCount: 1
                      totalPages: 1
                      bots:
                        - botId: fb79920229d144608ebf665a10e50275
                          botName: Support Agent
                          botInfo:
                            botDescription: Handles inbound customer support calls.
                            botLanguage:
                              - en-IN
                            botRegion: asia
                            botTimezone: Asia/Kolkata
                          createdAt: '2026-04-01T10:00:00Z'
                          updatedAt: '2026-07-01T12:00:00Z'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    StandardResponse:
      type: object
      properties:
        status:
          type: string
          example: success
        requestId:
          type: string
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        message:
          type: string
        response:
          type: object
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          example: error
        requestId:
          type: string
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        message:
          type: string
  responses:
    ServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key with 'agents' permission

````