Back to Home
Dashboard

Quick Start Guide

Get up and running with the Lead Management API in under 5 minutes

Start here
5 min read

Before You Start

You'll need an API key from your workspace settings

Basic knowledge of REST APIs and HTTP requests

A tool like curl, Postman, or your preferred programming language

Get Your API Key

Where to Find Your API Key & Chatbot ID

The two values every request needs, and exactly where they live in the dashboard

Your API key (workspace settings)

  1. Sign in to the dashboard and open the workspace that owns your chatbot.
  2. In the left sidebar, expand Workspace Setup and click API Keys.
  3. Click Create API Key and give it a name.
  4. Copy the generated key — it starts with sk-workspace_. The full key is shown only once, at creation — store it somewhere safe (an environment variable, never client-side code).

The key grants access to every chatbot in that workspace — one key covers chat, leads, and webhooks.

Your chatbot ID (chatbot sidebar)

  1. Open the chatbot in the dashboard (from your workspace's chatbot list).
  2. Look at the bottom of the left sidebar — you'll see a badge with your chatbot's name and a copy icon.
  3. Click the badge — the chatbot ID is copied to your clipboard (the icon turns into a checkmark, and hovering shows the full ID).

The ID looks like cmqviwwzi0000q0v9t5hj526q and goes into the {chatbotId} part of every endpoint path.

1

API Base URL

All API requests are made to this base URL

Production URL

https://pollybot.app/api/v1

Note: All endpoints are versioned with /v1 prefix.

2

Authentication

Include your API key in the Authorization header

Bearer Token Format

Authorization: Bearer sk-workspace_your_api_key_here

Security: Keep your API key secure! Never expose it in client-side code or public repositories.

3

Make Your First Request

Test your setup by fetching leads

Using cURL

curl -X GET "https://pollybot.app/api/v1/chatbots/your-chatbot-id/leads" \
  -H "Authorization: Bearer sk-workspace_your_api_key_here" \
  -H "Content-Type: application/json"

Using JavaScript

const response = await fetch('https://pollybot.app/api/v1/chatbots/your-chatbot-id/leads', {
  headers: {
    'Authorization': 'Bearer sk-workspace_your_api_key_here',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();

Expected Response

{
  "success": true,
  "data": [
    {
      "id": "lead_123",
      "name": "John Doe",
      "email": "john@example.com",
      "company": "Acme Corp",
      "status": "new",
      "createdAt": "2025-01-10T10:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  }
}

🎉 You're All Set!

Your API integration is working. Here's what to explore next:

Explore Lead Endpoints

Full CRUD operations

Authentication Details

Security best practices

Rate Limiting

Request limits & headers