List Agents | BookedIn Documentation

curl https://api.bookedin.ai/api/v1/agents \
     -H "X-API-Key: <apiKey>"

[
  {
    "id": "agt_abc123xyz",
    "business_id": "string",
    "name": "Sales Agent",
    "agent_config": {
      "prompt": "You are a helpful sales assistant for Acme Corp. Be professional, friendly, and focus on understanding customer needs before suggesting solutions.",
      "objective": "Book a demo call with qualified leads",
      "extract_values": [
        "company_name",
        "budget",
        "timeline",
        "decision_maker"
      ],
      "webhook_url": "https://your-server.com/webhooks/bookedin",
      "model": "openai/gpt-4.1",
      "timezone": "America/New_York"
    },
    "channel_profiles": {
      "vapi_profile": {
        "enabled": false,
        "channel_specific_prompt": "string",
        "first_message": "Hi, this is Sarah from Acme Corp. Is this a good time to talk?",
        "voice": {
          "id": "Savannah",
          "provider": "vapi"
        },
        "background_sound": "office",
        "tools": [
          "string"
        ],
        "model": "gpt-4.1",
        "provider": "openai"
      },
      "twilio_sms_profile": {
        "enabled": false,
        "channel_specific_prompt": "string",
        "first_message": "Hi {{first_name}}! This is Sarah from Acme Corp. I wanted to follow up on your inquiry.",
        "split_messages": true,
        "tools": [
          "string"
        ],
        "model": "openai/gpt-4.1",
        "selective_handling": {
          "enabled": false,
          "keywords": [
            "string"
          ],
          "prompt": "string"
        }
      },
      "whatsapp_profile": {
        "enabled": false,
        "channel_specific_prompt": "string",
        "first_message": "Hi {{first_name}}! This is Sarah from Acme Corp. I wanted to follow up on your inquiry.",
        "split_messages": true,
        "tools": [
          "string"
        ],
        "model": "openai/gpt-4.1",
        "selective_handling": {
          "enabled": false,
          "keywords": [
            "string"
          ],
          "prompt": "string"
        }
      },
      "instagram_profile": {
        "enabled": false,
        "channel_specific_prompt": "string",
        "first_message": "Hi {{first_name}}! This is Sarah from Acme Corp. I wanted to follow up on your inquiry.",
        "split_messages": true,
        "tools": [
          "string"
        ],
        "model": "openai/gpt-4.1",
        "selective_handling": {
          "enabled": false,
          "keywords": [
            "string"
          ],
          "prompt": "string"
        }
      },
      "gmail_profile": {
        "enabled": false,
        "channel_specific_prompt": "string",
        "first_message": "Hi {{first_name}}! This is Sarah from Acme Corp. I wanted to follow up on your inquiry.",
        "split_messages": true,
        "tools": [
          "string"
        ],
        "model": "openai/gpt-4.1",
        "selective_handling": {
          "enabled": false,
          "keywords": [
            "string"
          ],
          "prompt": "string"
        }
      },
      "outlook_profile": {
        "enabled": false,
        "channel_specific_prompt": "string",
        "first_message": "Hi {{first_name}}! This is Sarah from Acme Corp. I wanted to follow up on your inquiry.",
        "split_messages": true,
        "tools": [
          "string"
        ],
        "model": "openai/gpt-4.1",
        "selective_handling": {
          "enabled": false,
          "keywords": [
            "string"
          ],
          "prompt": "string"
        }
      },
      "imessage_profile": {
        "enabled": false,
        "channel_specific_prompt": "string",
        "first_message": "Hi {{first_name}}! This is Sarah from Acme Corp. I wanted to follow up on your inquiry.",
        "split_messages": true,
        "tools": [
          "string"
        ],
        "model": "openai/gpt-4.1",
        "selective_handling": {
          "enabled": false,
          "keywords": [
            "string"
          ],
          "prompt": "string"
        }
      }
    },
    "created_at": "2024-01-15T09:30:00Z"
  }
]

Retrieve all AI agents for your business.

Authentication

X-API-Keystring

Your API key from Dashboard → Settings → API Keys

Your API key from [Dashboard → Settings → API Keys](https://dashboard.bookedin.ai/settings)

Query parameters

skipintegerOptionalDefaults to 0

Number of records to skip (pagination)

limitintegerOptional<=100Defaults to 100

Maximum number of records to return

Response

List of agents

idstring or null

Unique agent identifier

business_idstring or null

Business this agent belongs to

namestring or null

Display name for the agent

agent_configobject or null

Core agent configuration

channel_profilesobject or null

Channel-specific configurations. Enable and configure each channel independently.

created_atdatetime or null