API Overview

Build custom integrations with the Chatmefy REST API. Full access to conversations, leads, bots, and analytics.

Base URL

https://api.chatmefy.com/v1

All API endpoints are relative to this base URL. Use HTTPS only.

Available APIs

Conversations

List, read, and manage conversations

Messages

Read and send messages

Leads

Manage captured leads

Bots

Configure and manage bots

Knowledge

Upload and manage training data

Analytics

Retrieve metrics and reports

Authentication

Authenticate requests using your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Get your API key from Settings → API Keys in your dashboard.

Quick Example

Get recent leads

                curl -X GET "https://api.chatmefy.com/v1/leads" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Response
{
  "data": [
    {
      "id": "lead_abc123",
      "email": "john@company.com",
      "name": "John Smith",
      "score": 85,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "per_page": 20
  }
}

Response Format

Success Responses

Return 2xx status with JSON body containing data and optional meta

Error Responses

Return 4xx/5xx status with error object containing code and message

Rate Limiting

100 requests/minute. Headers include X-RateLimit-Remaining

SDKs & Libraries

JavaScript/TypeScript Available

Python Coming Soon

Ruby Coming Soon

PHP Coming Soon