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

# Get

> Retrieve the details of a single CometChat bot by UID using the REST API.

Returns `ERR_BOT_NOT_FOUND` when no bot exists with this UID. That includes a UID that belongs to a user who is not a bot, and an agent created through [AI Agents](https://www.cometchat.com/docs/ai-agents.md).

Responses omit every property whose value is empty or `false`, so a standard bot has no `isAIBot`, and a bot that has never had basic auth has no `useBasicAuth`, `username` or `password`. A bot whose `useBasicAuth` was set to `false` after it was saved still returns its stored `username` and `password`.

For a bot flagged as an AI bot, the response includes the flag:

```json theme={null}
{
  "data": {
    "uid": "faq-bot",
    "webhookURL": "https://example.com/webhooks/faq-bot",
    "groupChatSetting": "mentionedMessages",
    "enabled": true,
    "isAIBot": true,
    "createdAt": 1763472000
  }
}
```

> [!WARNING]
>
> The API returns the stored `password` value as it was saved, including after `useBasicAuth` is set to `false`. The example masks it as `********`.

For the complete error reference, see [Error Guide](https://www.cometchat.com/docs/articles/error-guide.md).


## OpenAPI

````yaml get /bots/{uid}
openapi: 3.0.0
info:
  title: Chat APIs
  description: Manage messages, users, groups for a particular app using our Chat API.
  version: '3.0'
servers:
  - url: https://{appId}.api-{region}.cometchat.io/v3
    variables:
      appId:
        default: appId
        description: (Required) App ID
      region:
        enum:
          - us
          - eu
          - in
        default: us
        description: Select Region
security: []
tags:
  - name: API Keys
    description: The API keys are used to authorise the APIs
  - name: Roles
    description: The roles are used to give user access rights
  - name: Users
    description: The REST collection for users.
  - name: Bots
    description: The bots relay messages from your app to a webhook.
  - name: Auth Tokens
    description: The auth tokens are used to login end users using client SDKs.
  - name: Blocked Users
    description: The REST collections for blocked users.
  - name: Friends
    description: List,add and remove friends by passing UID in path variables
  - name: Groups
    description: The REST collections for groups.
  - name: Banned Users
    description: Ban and Unban user by passing other UID in path variables.
  - name: Group Members
    description: The REST collections for group members.
  - name: Messages
    description: The REST collections for messages.
  - name: Conversations
    description: The REST collections for conversations.
  - name: Restrict Features
    description: Allows Restricting Features
  - name: Metrics
    description: Allows accessing Data Metrics
  - name: Triggers
    description: Allows adding triggers to a webhook.
  - name: Webhooks
    description: Allows accessing Webhooks.
  - name: Notifications
    description: Allows configuring Notifications core.
  - name: Moderation
    description: The REST collections for Moderations.
paths:
  /bots/{uid}:
    get:
      tags:
        - Bots
      summary: Get
      description: Retrieves bot details for a specified UID.
      operationId: get-bot
      parameters:
        - name: uid
          in: path
          description: An UID of a bot.
          required: true
          schema:
            type: string
          examples:
            string:
              summary: UID
              value: ''
      responses:
        '200':
          description: Fetched the bot
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: object
                type: object
              example:
                data:
                  uid: support-bot
                  webhookURL: https://example.com/webhooks/support-bot
                  groupChatSetting: mentionedMessages
                  useBasicAuth: true
                  username: support-bot
                  password: '********'
                  enabled: true
                  createdAt: 1763558400
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      description: API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).
      name: apikey
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.