Skip to main content
GET
/
leads
Get Leads
curl --request GET \
  --url https://eu-gcp-api.vg-stuff.com/v3/leads \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "email": "<string>",
      "name": "<string>",
      "phone": "<string>",
      "agentId": "<string>",
      "convoId": "<string>",
      "ts": 123,
      "created_at": "<string>",
      "metaData": {}
    }
  ]
}
Returns all leads for the specified agent. You must own the agent to access its leads.
Leads are automatically captured during conversations when users provide contact information (email, phone, name).

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
agentId
string
required

The unique identifier of the agent to get leads for

Response

Successful response

​
success
boolean
required

Indicates if the request was successful

​
message
string
required

Response message

​
data
object[]
required

Array of lead objects