LeadRat Builder CRM API#
v1.0.0 · REST · JSON · HTTPS only
A powerful REST API for lead capture, tracking, and management. Integrate lead pipelines, forms, and analytics directly into your product.
Base URL#
https://api.crm.builder.leadratd.com
Quick Start#
1. Get your API key#
2. Make your first request#
3. Parse the response#
{
"data": [
{
"id": "lead_01HXZ3K9",
"name": "Priya Sharma",
"email": "priya@example.com",
"status": "new",
"created_at": "2026-04-17T08:30:00Z"
}
],
"meta": {
"total": 1,
"page": 1,
"per_page": 20
}
}
Authentication#
LeadRat API supports two authentication methods:| Method | Header | Example |
|---|
| API Key | X-API-Key | X-API-Key: lr_live_xxxxxxxxxxxx |
| Bearer Token | Authorization | Authorization: Bearer <oauth_token> |
Security tip: Never expose your API key in client-side code. Use environment variables or a backend proxy.
Core Endpoints#
Leads#
| Method | Endpoint | Description |
|---|
GET | /leads | List all leads (supports filters & pagination) |
POST | /leads | Create a new lead |
GET | /leads/{id} | Retrieve a single lead by ID |
PUT | /leads/{id} | Update lead details |
DELETE | /leads/{id} | Delete a lead |
POST | /leads/{id}/tags | Add tags to a lead |
DELETE | /leads/{id}/tags/{tag} | Remove a tag from a lead |
Pipelines#
| Method | Endpoint | Description |
|---|
GET | /pipelines | List all pipelines |
GET | /pipelines/{id} | Get a single pipeline |
POST | /pipelines/{id}/leads | Move a lead into a pipeline stage |
Analytics#
| Method | Endpoint | Description |
|---|
GET | /analytics/summary | Overall lead conversion summary |
GET | /analytics/sources | Lead count breakdown by source |
GET | /analytics/funnel | Pipeline funnel report |
All request bodies must be sent as JSON with Content-Type: application/json
All timestamps are returned in ISO 8601 format (UTC)
All IDs are strings prefixed by resource type (e.g., lead_, pipe_)
Rate Limits#
| Plan | Requests per minute | Requests per day |
|---|
| Free | 30 | 1,000 |
| Growth | 200 | 50,000 |
| Pro | 1,000 | Unlimited |
Rate limit headers are returned on every response:X-RateLimit-Limit: 200
X-RateLimit-Remaining: 197
X-RateLimit-Reset: 1713343260
429 Too Many Requests. Implement exponential backoff before retrying.
Error Codes#
| HTTP Status | Code | Description |
|---|
400 | invalid_request | Missing or malformed request body |
401 | unauthorized | Invalid or missing API key |
403 | forbidden | Insufficient permissions for this action |
404 | not_found | Resource does not exist |
409 | conflict | Duplicate lead (same email) |
422 | validation_error | Field-level validation failed |
429 | rate_limit_exceeded | Too many requests |
500 | server_error | Unexpected error on our end |
Error response shape#
{
"error": {
"code": "validation_error",
"message": "The 'email' field is required.",
"details": [
{ "field": "email", "issue": "required" }
]
}
}
Webhooks#
LeadRat can push real-time events to your endpoint whenever a lead is created, updated, or changes stage.Configure webhooks in your dashboard under Settings → Webhooks.
SDKs & Libraries#
| Language | Package | Install |
|---|
| JavaScript / Node.js | leadrat-node | npm install leadrat-node |
| Python | leadrat-python | pip install leadrat |
| PHP | leadrat/leadrat-php | composer require leadrat/leadrat-php |
Changelog#
| Version | Date | Summary |
|---|
| v1.0.0 | 2026-04-17 | Initial public release |
Support#
Modified at 2026-04-16 19:09:20
