- Introduction
- Staff API Overview
- Leads API Overview
- Call Logs API Overview
- Tickets API Overview
- Deals Management API Overview
- List DealsGET
- Create a DealPOST
- Update a DealPUT
- Get a Deal DetailsGET
- List Deals SourcesGET
- List Deals PipelineGET
- Add a Deal CommentPOST
- Update a Deal CommentPUT
- Add an AttachmentPOST
- Delete an AttachmentDELETE
- List a Deal ServicesGET
- Get a Deal Service DetailGET
- Add a Deal ServicePOST
- Update a Deal ServicePUT
Leads Summary
GET
/leads/summary/{lead_id}
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 *****************
Responses
🟢200Success
application/json
Body
data
objectÂ
required
id
stringÂ
required
name
stringÂ
required
title
nullÂ
required
company
nullÂ
required
phonenumber
stringÂ
required
email
stringÂ
required
status
stringÂ
required
date
stringÂ
required
chat_id
stringÂ
required
assigned
stringÂ
required
is_public
stringÂ
required
chat
nullÂ
required
chat_date
nullÂ
required
lead_type
stringÂ
required
assigned_to
nullÂ
required
color
stringÂ
required
analytics
objectÂ
required
notes_count
integerÂ
required
attachment_count
integerÂ
required
message
stringÂ
required
Example
{
"data": {
"id": "1",
"name": "john",
"title": null,
"company": null,
"phonenumber": "01234XXXXXX",
"email": "[email protected]",
"status": "New",
"date": "2024-08-05 14:07:36",
"chat_id": "uyisa77",
"assigned": "0",
"is_public": "0",
"chat": null,
"chat_date": null,
"lead_type": "Sales",
"assigned_to": null,
"color": "#84CC16",
"analytics": {
"source": "3",
"analytics": "{\"city\":\"New York\",\"country\":\"US\",\"country_code\":\"PK\",\"latitude\":null,\"longitude\":null,\"region\":\"Sindh\",\"timezone\":\"UTC/GMT\"}",
"browser": "Google Chrome",
"source_url": "http://localhost/liveforce/",
"ip": "117.20.31.166",
"chat_start_time": "2023-09-13T11:06:31.060009Z",
"chat_end_time": "2024-08-05T09:07:36.406233Z",
"chat": "[{\"id\":\"S09XQ866FV_1\",\"created_at\":\"2023-09-13T11:06:31.060009Z\",\"visibility\":\"all\",\"type\":\"message\",\"properties\":{\"lc2\":{\"welcome_message\":true}},\"text\":\"Hello. How may I help you?\",\"author_id\":\"[email protected]\"},{\"id\":\"S09XQ866FV_2\",\"created_at\":\"2023-09-13T11:06:31.060011Z\",\"visibility\":\"all\",\"type\":\"message\",\"properties\":{\"source\":{\"client_id\":\"c5e4f61e1a6c3b1521b541bc5c5a2ac5\"}},\"text\":\"Hey\",\"author_id\":\"665ac64a-d751-4b4d-a1ed-4cbf46057f98\",\"custom_id\":\"owgq84cmaig\"},{\"id\":\"S09XQ866FV_3\",\"created_at\":\"2023-09-13T11:07:55.747000Z\",\"visibility\":\"all\",\"type\":\"message\",\"properties\":{\"source\":{\"client_id\":\"bb9e5b2f1ab480e4a715977b7b1b4279\"}},\"text\":\"Hi there! :wave: How can I help you today? \",\"author_id\":\"[email protected]\",\"custom_id\":\"1694603274419.96817553399\"},{\"id\":\"S09XQ866FV_4\",\"created_at\":\"2023-09-13T11:22:15.002002Z\",\"visibility\":\"agents\",\"type\":\"system_message\",\"text\":\"Chat is idle due to 10 minutes of inactivity\",\"system_message_type\":\"routing.idle\",\"text_vars\":{\"duration\":\"10\"}},{\"id\":\"S09XQ866FV_5\",\"created_at\":\"2023-09-13T11:27:20.006000Z\",\"visibility\":\"all\",\"type\":\"system_message\",\"text\":\"Chat archived due to 15 minutes of inactivity\",\"system_message_type\":\"routing.archived_inactive\",\"text_vars\":{\"duration\":\"15\"}}]"
},
"notes_count": 0,
"attachment_count": 0
},
"message": "success"
}
🟠404Not found
🟠401Unauthorized
Modified at 2024-09-05 09:36:59