Leads

Leads are users who input their information into the Support AI chatbot for additional communications.

Properties

Name
lead_id
Type
integer
Description
Unique identifier for the lead.
Name
lead_date
Type
string
Description
The date the lead was created.
Name
country
Type
string
Description
The country of origin for the lead.
Name
email
Type
string
Description
The email of the lead.
Name
name
Type
string
Description
The name of the lead.
Name
phone
Type
string
Description
The phone number of the lead.

GET/listLeads/:chatbot_id

Fetch all leads

Get a list of all leads of a specific chatbot of your account.

Request

GET

/listLeads/:chatbot_id

curl --request GET \
  --url https://api.supportai.com/listLeads/:chatbot_id \
  --header 'Authorization: Bearer IDZFdfiD...'

Response

{
  "success": true,
  "data": [
    {
      "lead_id": 123...,
      "lead_date": "2024-01-16T22:43:53.892531+00:00",
      "country": "US",
      "email": "[email protected]",
      "name": "John Smith",
      "phone": "310 000-0000"
    }
    ...
  ]
}