Leads
Manage sales leads. Ability to create, edit, view, and delete leads.
Available Endpoints
| Method |
Path |
Description |
| GET |
/api/leads |
List leads |
| GET |
/api/leads/{id} |
View lead details |
| POST |
/api/leads |
Create new lead |
| PUT |
/api/leads/{id} |
Full update of a lead |
| PATCH |
/api/leads/{id} |
Partial update of a lead |
| DELETE |
/api/leads/{id} |
Delete a lead |
Example Request
curl -X GET "https://example.com/api/leads" \
-H "Authorization: Bearer {token}"
Success Response (200)
{
"records": [],
"meta": {
"total": 0,
"current_page": 1,
"per_page": 20
}
}
Errors
| Code |
Description |
| 401 |
Invalid token |
| 403 |
Access denied |
| 404 |
Record not found |
| 422 |
Validation error |