> ## 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 FAQs

> Retrieve all FAQ entries for a specific agent

## Overview

Retrieve all FAQ entries currently stored for the specified agent and environment. Use the returned `faqId` values to update or delete individual entries.

## Required Permission

`agents`

## Path Parameters

| Name    | Type   | Required | Description              |
| ------- | ------ | -------- | ------------------------ |
| `botId` | string | Yes      | Unique agent identifier. |

## Query Parameters

| Name          | Type   | Required | Description                                                                               |
| ------------- | ------ | -------- | ----------------------------------------------------------------------------------------- |
| `environment` | string | No       | Filter by environment: `development`, `staging`, or `production`. Default: `development`. |

## Example cURL

```bash theme={null}
curl "https://api.inya.ai/platform/v1/agents/fb79920229d144608ebf665a10e50275/faqs?environment=development" \
  -H "x-api-key: <your_api_key>"
```

## Response

### Success (200)

```json theme={null}
{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "FAQs retrieved successfully",
  "response": {
    "faqs": [
      {
        "faqId": "faq_xyz001",
        "questions": ["What are your business hours?", "When are you open?"],
        "answer": "We are open Monday to Friday, 9am to 6pm IST.",
        "language": "en-IN",
        "signal": null
      },
      {
        "faqId": "faq_xyz002",
        "questions": ["How do I cancel my subscription?"],
        "answer": "To cancel, visit our website or contact billing@example.com.",
        "language": "en-IN",
        "signal": "CANCELLATION_INTENT"
      }
    ],
    "totalCount": 2
  }
}
```

## Response Fields

| Field              | Type      | Description                                                          |
| ------------------ | --------- | -------------------------------------------------------------------- |
| `faqs[].faqId`     | string    | Unique FAQ identifier. Use this when updating or deleting the entry. |
| `faqs[].questions` | string\[] | Question phrasings that trigger this FAQ.                            |
| `faqs[].answer`    | string    | The spoken answer returned when a match is detected.                 |
| `faqs[].language`  | string    | BCP-47 language code for this entry.                                 |
| `faqs[].signal`    | string    | Optional analytics label. `null` if not set.                         |
| `totalCount`       | integer   | Total FAQ entries for this agent in the specified environment.       |

### Error Responses

**404 Not Found** - Agent does not exist

```json theme={null}
{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Agent not found"
}
```

## Use Cases

* Reviewing existing FAQ content before making updates
* Retrieving `faqId` values needed for **Update FAQ** or **Delete FAQs**
* Auditing FAQ coverage across languages and environments

<Tip>
  Always list FAQs first to get the `faqId` values before calling **Update FAQ** or **Delete FAQs**.
</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/{botId}/faqs
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/{botId}/faqs:
    get:
      tags:
        - AgentFAQ
      summary: List FAQ entries
      description: Retrieve all FAQ entries currently stored for an agent.
      operationId: listFaqs
      parameters:
        - $ref: '#/components/parameters/AgentId'
        - name: environment
          in: query
          description: Filter by environment. Default is development.
          required: false
          schema:
            type: string
            enum:
              - development
              - staging
              - production
            default: development
      responses:
        '200':
          description: FAQs retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
              examples:
                success:
                  value:
                    status: success
                    requestId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    message: FAQs retrieved successfully
                    response:
                      faqs:
                        - faqId: faq_xyz001
                          questions:
                            - What are your business hours?
                            - When are you open?
                          answer: We are open Monday to Friday, 9am to 6pm IST.
                          language: en-IN
                          signal: null
                      totalCount: 1
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    AgentId:
      name: botId
      in: path
      required: true
      description: Unique identifier of the agent
      schema:
        type: string
  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:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    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

````