Chatbot Overview
Conversational Bots
Intents & Entities
Intelligent Bots's Approach Conversational Platform
Bot Concepts and Terminology
Natural Language Processing (NLP)
Bot Types
Bot Tasks
Starting with Platform
How to Access Bot Builder
Working with Bot Builder
Building your first Bot
Getting Started with Building Bots
Using the Dialog Builder Tool
Creating a Simple Bot
Release Notes
Latest Updates
Older Releases
Bot Builder
Creating a Bot
Dialog Task
Working with User Intent & Dialog Node
Working with Entity Node
Supported Entity Types
Working with Composite Entities
Supported Time Zones
Supported Colors
Supported Company Names
Working with Message & Confirmation Nodes
Working with Service Node
Implementing Custom Authentication
Enabling 2-way SSL for Service nodes
Working with Script Node
Working with Agent Transfer Node
Working with WebHook Node
Defining Connections & Transitions
Managing Dialogs
Prompt Editor
Context Object
Session and Context Variables
Action & Information Task
Working with Action Tasks
Working with Information Tasks
Establishing Flows
Alert Tasks
Working with Alert Tasks
Managing Ignore Words and Field Memory
Knowledge Tasks
Building Knowledge Graph
Importing and Exporting Bot Ontology
Knowledge Extraction
Natural Language
Machine Learning
ML Model
Fundamental Meaning
Knowledge Graph Training
Ranking and Resolver
NLP Detection
NLP Settings and Guidelines
Bot Intelligence
Dialog Management
Context Management
Amend Entity
Multi-Intent Detection
Default Conversations
Channel Enablement
Test & Debug
Talking to Bot
Utterance Testing
Batch Testing
Recording Conversations
Publishing your Bot
Analyzing your Bot
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
Universal Bots
Enabling Languages
Smart Bots
Sample Bots
Travel Planning
Flight Search
Event Based Bot Actions
Sentiment Analysis
Tone Analysis
Sentiment Management
Bot Settings
Bot Functions
General Settings
PII Settings
Customizing Error Messages
Bot Management
API Guide
API Overview
API List
SDK Overview
SDK Configuration
SDK Security
SDK App Registration Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Using the BotKit SDK
Installing the BotKit SDK
Events for the BotKit SDK
Functions for the BotKit SDK
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
Web Socket Connect & RTM
Bot Administration
Bots Admin Console
User Management
Managing Your Users
Managing Your Groups
Role Management
Bots Management
Inviting Users
Sending Bulk Invites to Enroll Users
Importing Users and User Data
Synchronizing Users from Active Directory
Security & Compliance
Using Single Sign-On
Cloud Connector
Bot Store
Creating a Bot Account
Adding a Bot
Choosing a Channel for a Bot
Interacting with a Bot
Setting Up Web Service Alerts
Setting Up RSS Alerts
Setting Up the Webhook Bot
Custom Bots
Bots for your Customers FAQs
Bots for your Workforce FAQs
Adding Bots
Contacting Support
Setting Up Filters
Bot Store Settings
  1. Home
  2. Docs
  3. Bots
  4. API Guide
  5. Get Bots API

Get Bots API

To retrieve the list of bots available in an account.
GET https://{{host}}/api/public/bots

Query Parameters

Parameter Required/Optional Description
host Required Environment URL, for example,
offset Optional Specify the page number from which to start fetching the bots created in the account. If unspecified, it starts from 0, which is the first page of the list of bots.
limit Optional The number of bots to fetch. The maximum applicable limit is 50.


Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}

Response Content Type


Sample Request

curl -X GET \
http://{{host}}/api/public/bots \

Sample Response

    "total": 3,
    "availableMore": true,
    "bots": [
            "_id": "st-008c3w91-c69a-4ef3-a3b7-bd942bc371ab",
            "createdBy": "u-81f22c33-22f5-58ce-84fb-d894ece4baeb",
            "defaultLanguage": "en",
            "type": "taskbot",
            "purpose": "customer",
            "accountId": "57f38c8452ee95351620b261",
            "resourceid": "btstreams",
            "status": "published",
            "name": "TestBot",
            "description": "Test Bot"
            "_id": "st-009b228e-4080-5f1a-8ef1-64f90e17fbac",
            "createdBy": "u-04361202-0169-56c2-a7b1-b5495861b2ad",
            "type": "taskbot",
            "purpose": "customer",
            "defaultLanguage": "en",
            "accountId": "57f38c8452ee95351620b261",
            "resourceid": "btstreams",
            "status": "configured",
            "name": "ShopBot",
            "description": "Shop bot"
            "_id": "st-00a9b235-48e9-53fe-bb66-2de082872cde",
            "createdBy": "u-accb0713-df37-336e-b030-85dd1fb49e82",
            "type": "taskbot",
            "purpose": "customer",
            "defaultLanguage": "en",
            "accountId": "57f58c8452ee95351620b261",
            "resourceid": "btstreams",
            "status": "published",
            "name": "Test Voice Bot",
            "description": "Test Bot for Voice Pilot"