Get Leads

curl --request GET \
  --url https://eu-gcp-api.vg-stuff.com/v3/leads \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "<string>",
  "data": "<array>"
}

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": "<array>"
}

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).

Authorization

string

header

required

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

agentId

string

required

page

integer

default:1

Required range: x >= 1

limit

integer

default:100

Required range: 1 <= x <= 500

Successful response

success

boolean

required

message

string

required

data

array

required