Returns list of all leads with their info
/leads
https://api.oauth.pabau.com/{api_key}/leads
Request
| Query Parameters: | |
| api_key * | |
| per_page | (int) If not sent, the default is 20. Maximum 50 |
| page | (int) If not sent, the first 20 result will be sent |
| order | ASC or DESC. Default DESC |
Response sample
application/json
{
"success": true,
"total": 5,
"leads": [
{
"lead_id": "2",
"Salutation": null,
"first_name": "Lisa ",
"last_name": "Adams",
"email": "lisa@pabau.com",
"phone": null,
"mobile": "123456789",
"lead_status": "3",
"lead_source": "2",
"gender": null,
"avatar": null,
"description": "",
"owner_id": "4",
"customer_id": null
},
{
"lead_id": "3",
"Salutation": null,
"first_name": "John",
"last_name": "Doe",
"email": "john@pabau.com",
"phone": null,
"mobile": "123456789",
"lead_status": "3",
"lead_source": "2",
"gender": null,
"avatar": null,
"description": "",
"owner_id": "4",
"customer_id": null
}
],
"lead_stages": [
{
"id": "1",
"status_name": "Open Lead"
},
{
"id": "2",
"status_name": "Contact - 1st Attempt"
},
{
"id": "3",
"status_name": "Contact - 2nd Attempt"
},
{
"id": "4",
"status_name": "Lost - Mark As Junk"
},
{
"id": "5",
"status_name": "Converted"
}
]
}