---
title: "Get All Bots"
method: GET
path: "/v1/business/bot/all"
tags: ["Botsonic Business Bots"]
---

# Get All Bots

`GET /v1/business/bot/all`

Get all bots in paginated format

## Query parameters

- `search_query` string — Search for bot matching particluar query
- `sort_by` 'id' | 'owner_id' | 'vectorstore_index_id' | 'vectorstore' | 'pinecone_index_config' | 'is_deleted' | 'is_shared' | 'is_sample_bot' | 'deletion_datetime' | 'created_at' | 'updated_at' | 'workspace_id' | 'bot_template_id' | 'corresponding_cloned_bot_with_free_credits' | 'is_cloned_for_free' | 'migration_status' — Select attribute to sort by
- `sort_order` 'asc' | 'desc' — An enumeration.
- `workspace_id` string
- `page` integer
- `size` integer

## Response `200`

Successful Response

- PageBotOutput
  - `items` BotOutput[], required
    - `id` string, uuid, required
    - `owner_id` string, required
    - `vectorstore_index_id` string, required
    - `is_deleted` boolean, required
    - `is_shared` boolean, required
    - `vectorstore` 'pinecone' | 'weaviate', required — An enumeration.
    - `pinecone_index_config` string, uuid
    - `workspace_id` string, uuid, required
    - `deletion_datetime` string, date-time
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `bot_info_config` BotInfoConfigBase, required
      - `id` string, uuid, required
      - `bot_id` string, uuid, required
      - `bot_name` string, required
      - `company_name` string
      - `company_logo` string
      - `chatbot_avatar` string
      - `chatbot_color` string
      - `chatbot_subheading` string
      - `welcome_message` string, required
      - `bot_description` string, required
      - `no_sources_added_message` string, required
      - `server_error_message` string, required
      - `support_contact_number` string
      - `user_limit_warning_message` string
      - `is_show_chat_sonic_brand` boolean, required
      - `button_icon` string
      - `widget_position` 'left' | 'right', required — An enumeration.
      - `is_show_sources` boolean, required
      - `is_open_on_initial_render` boolean, required
      - `is_show_recaptcha` boolean, required
      - `show_floating_welcome_message` boolean, required
      - `show_post_chat_feedback` boolean
      - `custom_placeholder` string
      - `show_starter_widget` boolean
      - `hide_user_form` boolean, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `individual_user_rate_limit` integer, required
      - `roi_hourly_rate` integer, required
      - `roi_country_code` string
      - `individual_user_rate_limit_timeframe` 'day' | 'week' | 'month', required — An enumeration.
      - `block_users_without_ip` boolean, required
      - `openai_assistant_id` string
      - `email_transcript` boolean
      - `is_show_follow_up_questions` boolean, required
    - `bot_prompt_config` BotPromptConfigBase, required
      - `id` string, uuid, required
      - `bot_id` string, uuid, required
      - `bot_guidelines` string
      - `response_length` 'short' | 'medium' | 'long', required — An enumeration.
      - `model` 'gpt-3.5' | 'gpt-4' | 'gpt-4o' | 'claude-2' | 'gpt-3.5-1106' | 'mistral-7b' | 'mixtral-8x7b' | 'llama-2-70b' | 'mistral-medium' | 'pplx-70b-online' | 'pplx-7b-online' | 'gemini-pro' | 'mistral-large' | 'command-r' | 'gpt-4o-mini' | 'botsonic-agent', required — An enumeration.
      - `prompt_revision` 'legacy' | 'bs-170724', required — An enumeration.
      - `experimental_prompt_revisions` ExperimentalPromptRevisions[], required
      - `allow_image_scraping_content` boolean
      - `brand_persona_id` string, uuid
      - `generation_language` string, required
      - `condensed_bot_guidelines` string
      - `multilingual_support` boolean
      - `is_conversational` boolean
      - `response_confidence` integer
      - `engine_id` string, uuid, required
      - `selected_knowledge_sources` string[], required
      - `system_prompt` string
      - `custom_system_prompt` string
      - `enterprise_system_prompt` string
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
    - `bot_template_id` 'e_commerce' | 'customer_support' | 'personalized' | 'openai_assistant' | 'agent', required — An enumeration.
    - `corresponding_cloned_bot_with_free_credits` string, uuid
    - `is_cloned_for_free` boolean
    - `is_sample_bot` boolean
    - `migration_status` 'not_started' | 'in_progress' | 'completed' | 'error' — An enumeration.
  - `total` integer
  - `page` integer
  - `size` integer
  - `pages` integer

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/botsonic/apis/botsonic-api-docs.md) · [All operations](https://skmtc.dev/botsonic/apis/botsonic-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botsonic/botsonic-api-docs/revisions/8719fe19681e/schema)