List Leads
GET/leads/listRetrieves a list of all leads.
Request
Query Params
offset
string
optional
Example:
50
limit
string
optional
Example:
10
status
string
optional
Example:
active
Responses
Success(200)
Validation(422)
Unauthorized(401)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
array [object {10}]
required
id
string
optional
name
string
optional
phonenumber
string
optional
email
string
optional
status
string
optional
date
string
optional
type_id
string
optional
lead_type
string
optional
lead_status
string
optional
color
string
optional
page
object
required
current_page
integer
required
from
integer
required
to
integer
required
total
integer
required
per_page
integer
required
last_page
integer
required
next
integer
required
previous
integer
required
count
object
required
active
integer
required
closed
integer
required
disputed
integer
required
total_leads
integer
required
message
string
required
Example
{
"data": [
{
"id": "1",
"name": "john",
"phonenumber": "01244xxxxxxx",
"email": "[email protected]",
"status": "1",
"date": "2024-08-05 14:07:36",
"type_id": "2",
"lead_type": "Sales",
"lead_status": "New",
"color": "#84CC16"
}
],
"page": {
"current_page": 1,
"from": 1,
"to": 1,
"total": 1,
"per_page": 10,
"last_page": 0,
"next": -1,
"previous": 0
},
"count": {
"active": 1,
"closed": 0,
"disputed": 0,
"total_leads": 1
},
"message": "success"
}Last modified: 2 months ago