Fetch Agent Leads

Fetch Agent Leads

curl --request GET \
  --url https://api.chat-dash.com/v1/public/agents/{agentId}/leads \
  --header 'Authorization: <authorization>'

[
  {
    "_id": "<string>",
    "phone": "<string>",
    "customFields": {},
    "tags": [
      "<string>"
    ]
  }
]

GET

agents

{agentId}

leads

Fetch Agent Leads

curl --request GET \
  --url https://api.chat-dash.com/v1/public/agents/{agentId}/leads \
  --header 'Authorization: <authorization>'

[
  {
    "_id": "<string>",
    "phone": "<string>",
    "customFields": {},
    "tags": [
      "<string>"
    ]
  }
]

Authorization

string

required

All requests to the ChatDash API must be validated with the agency API Key found on your agency profile

agentId

string

required

The ID of the agent

_id

string

The ID of the lead

phone

string

The phone number of the lead

customFields

object

The user defined fields for the lead. Keys are field names, values are field values.

Show child attributes

customFields.{key}

string