Liveforce
  1. Leads API Overview
Liveforce
  • Introduction
  • Staff API Overview
    • List Staff Members
      GET
    • Get Staff Member Details
      GET
    • Create a Staff Member
      POST
    • Update a Staff Member
      PUT
  • Leads API Overview
    • List Leads
      GET
    • Get Lead Details
      GET
    • Leads Summary
      GET
    • Leads Count by Status
      GET
    • Leads Types
      GET
    • Lead Notes List
      GET
    • Lead Note Detail
      GET
    • Lead Notes Create
      POST
    • Lead Notes Update
      PUT
    • Lead Files
      GET
    • Upload Lead File
      POST
    • Generate Report
      GET
    • Generate CSV Report
      GET
  • Call Logs API Overview
    • List Call Logs
      GET
    • Get Call Log Detail
      GET
  • Tickets API Overview
    • List Tickets
      GET
    • Create a Ticket
      POST
    • Get Ticket Details
      GET
    • List Ticket Statuses
      GET
  • Deals Management API Overview
    • List Deals
      GET
    • Create a Deal
      POST
    • Update a Deal
      PUT
    • Get a Deal Details
      GET
    • List Deals Sources
      GET
    • List Deals Pipeline
      GET
    • Add a Deal Comment
      POST
    • Update a Deal Comment
      PUT
    • Add an Attachment
      POST
    • Delete an Attachment
      DELETE
    • List a Deal Services
      GET
    • Get a Deal Service Detail
      GET
    • Add a Deal Service
      POST
    • Update a Deal Service
      PUT
  1. Leads API Overview

List Leads

GET
/leads/list
Retrieves a list of all leads.

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Query Params
offset
string 
optional
Example:
50
limit
string 
optional
Example:
10
status
string 
optional
Example:
active

Responses

🟢200Success
application/json
Body
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"
}
🟠422Validation
🟠401Unauthorized
Modified at 2024-09-05 09:36:16
Previous
Leads API Overview
Next
Get Lead Details
Built with