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

# List available agents.



## OpenAPI

````yaml /openapi/chat-client.yaml get /agents
openapi: 3.0.3
info:
  version: 1.0.0
  title: HealviChat Client API
servers:
  - url: https://{tenant_domain}/third-party/v1
    variables:
      tenant_domain:
        default: your-tenant.onhealvi.com
        description: Your tenant domain
security:
  - bearerAuth: []
paths:
  /agents:
    get:
      tags:
        - agents
      summary: List available agents.
      parameters:
        - in: query
          name: channel
          description: Optional channel filter.
          schema:
            $ref: '#/components/schemas/Channel'
          required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PaginatedResult'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Agent'
components:
  schemas:
    Channel:
      description: Type of messenger service.
      type: string
      enum:
        - bridge
        - whatsapp
        - facebook
        - widget
    PaginatedResult:
      type: object
      properties:
        data:
          description: |
            Default count: 100
          type: array
          items: {}
        links:
          type: object
          properties:
            first:
              type: string
            last:
              type: string
            prev:
              type: string
              nullable: true
            next:
              type: string
              nullable: true
        meta:
          type: object
          properties:
            current_page:
              type: integer
            from:
              type: integer
            to:
              type: integer
            last_page:
              type: integer
            per_page:
              type: integer
            total:
              type: integer
            path:
              type: string
            links:
              type: array
              items: {}
    Agent:
      description: |
        Represents an agent belonging to a messenger service.
        A business phone number registered on WhatsApp is an agent.
      type: object
      properties:
        id:
          type: integer
          description: Internal ID.
        channel:
          $ref: '#/components/schemas/Channel'
        display_id:
          type: string
          description: An unique identifier within a channel.
          example: 4915223567929
        name:
          type: string
          description: Name received from channel.
          example: John Doe
        in_sync:
          type: boolean
          description: >
            Indicates whether the agent is actually a connected agent (e.g. a
            WhatsApp number).

            In case of disconnecting a tenants service, this flag will turn
            false to keep conversations.

            You should not use this agent anymore to send messages as you will
            receive errors.
        healthy:
          type: boolean
          description: Whether the agent is healthy and can send/receive messages.
          example: true
        unread_conversations_count:
          type: integer
          description: Number of conversation with at least one unread customer message.
        bot_id:
          type: integer
          description: Default bot that should handle new conversations.
          nullable: true
        proxy_email:
          type: string
          description: >
            If given, messages will be sent to this email address.

            When a reply to that email is received, the message will be
            forwarded to the customer.
          nullable: true
        whatsapp:
          description: Field only available if this agent has channel "whatsapp".
          type: object
          properties:
            is_on_biz_app:
              type: boolean
              description: Whether the agent is connected to a BizApp.
              example: false
            is_missing_funds:
              type: boolean
              description: >
                Whether the agent (360dialog number) needs to pay in order to
                send billable messages.

                (e.g. WhatsApp marketing template messages)
              example: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````