Documentation & API Reference

Welcome to the LeadSoras CRM Developer Docs. Here you will find guides, concepts, and API references to help you integrate LeadSoras CRM into your custom software ecosystem, synchronize databases, and automate your sales pipeline.

Our API is built on RESTful principles, returns JSON-encoded responses, and uses standard HTTP response codes to communicate errors.

💬

WhatsApp Business API Integration Guide

Complete step-by-step documentation for connecting your WhatsApp Business number with LeadSoras CRM. Covers Meta Business setup, Evolution API installation, webhook configuration, and sending messages.

📖 Full Guide — 17 sections →

Quickstart Guide

To begin making calls to the API, you must first retrieve an API Access Token. Access Tokens are issued within your CRM Settings page (Admin only).

Include the access token in the HTTP header of all requests:

Authorization: Bearer YOUR_API_ACCESS_TOKEN

Authentication API

Perform programmatic agent sign-in or generate JWT credentials using the login endpoint:

POST /api/users/login
Content-Type: application/json

{ "email": "agent@company.com", "password": "yourpassword" }

A successful login response returns user statistics along with the active JWT validation token.

Webhooks

LeadSoras CRM supports webhook integrations for receiving leads from multiple platforms:

POST /api/webhooks/facebook — Facebook Lead Ads
POST /api/webhooks/tiktok — TikTok Lead Ads
POST /api/webhooks/snapchat — Snapchat Lead Ads
POST /api/webhooks/evolution — Evolution API (WhatsApp)
POST /api/webhooks/:source — Generic webhook endpoint

For detailed WhatsApp webhook configuration, see the WhatsApp Integration Guide → Webhooks section.

WhatsApp API Endpoints

All WhatsApp endpoints require JWT authentication.

POST /api/whatsapp/send — Send a single message
POST /api/whatsapp/bulk — Send bulk messages
GET  /api/whatsapp/messages — Get message history
GET  /api/whatsapp/messages/:leadId — Get messages by lead
GET  /api/whatsapp/stats — Get messaging statistics
POST /api/whatsapp/pause — Pause message sending
POST /api/whatsapp/resume — Resume message sending
POST /api/whatsapp/retry/:id — Retry a failed message

For detailed setup and configuration, see the full WhatsApp Integration Guide.