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

# Get online agents

> Returns list of currently online support agents



## OpenAPI

````yaml /openapi.json get /api/widget/agents/online
openapi: 3.0.0
info:
  title: g-tateth CRM API
  version: 1.1.0
  description: >-
    RESTful API for g-tateth CRM platform. Manage conversations, customers,
    users, and more.
  contact:
    name: g-tateth Support
    email: support@g-tateth.com
  license:
    name: Proprietary
servers:
  - url: https://api.g-tateth.com
    description: Production server
  - url: https://staging-api.g-tateth.com
    description: Staging server
security: []
tags:
  - name: Health
    description: API health and status check (no authentication required)
  - name: Authentication
    description: API key and JWT authentication
  - name: API Keys
    description: Create and manage your tenant API keys (requires JWT session)
  - name: Conversations
    description: Manage customer conversations (supports API key or JWT)
  - name: Customers
    description: Manage customer profiles (supports API key or JWT)
  - name: Webhooks
    description: Subscribe to real-time events via webhooks (supports API key or JWT)
  - name: Analytics
    description: Usage analytics and performance metrics (supports API key or JWT)
  - name: Data Privacy
    description: >-
      GDPR data rights endpoints — export, deletion, access, rectification,
      restriction, and objection requests (requires JWT session)
  - name: Widget
    description: Chat widget API endpoints (public — no authentication required)
  - name: Telephony
    description: Voice and phone API endpoints
  - name: Zoho Integration
    description: Zoho CRM integration and data import endpoints
paths:
  /api/widget/agents/online:
    get:
      tags:
        - Widget
      summary: Get online agents
      description: Returns list of currently online support agents
      parameters:
        - in: query
          name: tenantDomain
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Online agents retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      agents:
                        type: array
                        items:
                          type: object

````