Quick start
What you'll achieve: Create a project, get an API key, and capture your first lead via the API in under 10 minutes.
Step 1: Create an account and project
Sign up at Start free. After login, create your first project from the dashboard. Give it a name (e.g. "My website").
Step 2: Get your API key
Open the project → Install (or Settings). Create an API key. Copy it — it's shown only once.
Add your site domain to Allowed domains so the API accepts requests from that origin (e.g. https://yoursite.com or http://localhost:8000 for testing).
Step 3: Send a test lead
Use the Lead API with your key. Endpoint:
POST https://www.swiftcrm.in/api/public/lead
Required header: X-Api-Key: YOUR_PROJECT_API_KEY
Body (JSON): at least one of name, email, or phone (all optional but send at least one for a useful lead).
curl -X POST "https://www.swiftcrm.in/api/public/lead" \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_PROJECT_API_KEY" \
-d '{"email":"[email protected]","name":"Test User"}'
Success response (201):
{
"code": "LEAD_CREATED",
"message": "Lead captured.",
"request_id": "...",
"lead_id": 123
}
Step 4: Check the dashboard
Open your project → Leads. Your test lead appears there. From here you can export CSV, use the API, or wire webhooks (Starter plan and above).
Next: Install the widget on your site, or read the full API reference.