Skip to main content
GET
/
chatbots
List chatbots
curl --request GET \
  --url https://api.awardee.dev/v1/chatbots \
  --header 'Authorization: Bearer <token>'
{
  "object": "<string>",
  "total": 0,
  "page": 0,
  "page_size": 0,
  "data": [
    {
      "object": "<string>",
      "id": "8f3a9d2e-1b4c-4f5d-9e8a-7c3b2a1d0f9e",
      "name": "Support Bot",
      "slug": "support-bot",
      "public_slug": "k7Hq3M2",
      "url": "https://chatbot.awardee.dev/k7Hq3M2",
      "description": "Public-facing support assistant for Acme Inc.",
      "welcome_message": "Hi! How can I help?",
      "welcome_subtitle": "<string>",
      "system_prompt": "You are a helpful support agent for Acme Inc.",
      "model": "gpt-4.1-mini",
      "primary_color": "#007495",
      "logo_url": "https://cdn.awardee.dev/logos/acme.png",
      "tone": "friendly",
      "suggestions": [
        "Reset my password",
        "Pricing",
        "Contact a human"
      ],
      "human_support_enabled": true,
      "password_protected": true,
      "page_ids": [
        "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
      ],
      "article_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "category_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "location": {
        "enabled": true,
        "address": "<string>",
        "lat": 123,
        "lng": 123,
        "place_id": "<string>"
      },
      "web_search_enabled": true,
      "conversation_count": 123,
      "last_active_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer aw_live_…. Manage keys in the dashboard under Settings → API Keys.

Query Parameters

page
integer
Required range: 1 <= x <= 9007199254740991
page_size
integer
Required range: 1 <= x <= 100
status
enum<string>
Available options:
draft,
active,
paused,
archived
sort
enum<string>
Available options:
recent,
name

Response

Chatbots

object
string
required
Allowed value: "list"
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
page
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
page_size
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
data
object[]
required