Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Sales Agents V2

Get Sales Agent by lead ID

Retrieves the Sales Agent (AI Assistant) configuration associated with the specified lead.

get/v2.0/sales-agents/by-lead

Query parameters

leadIdinteger required

Lead ID

Headers

Authorizationstring required

Bearer [access_token]

Response

Sales Agent found successfully

idinteger

Sales Agent ID

userIdinteger

User ID who owns this Sales Agent

agentNamestring

Agent's full name

agentHeadUrlstring

Agent's avatar URL

assistantNamestring

AI Assistant name

assistantHeadUrlstring

AI Assistant avatar URL

virtualNumberstring

Virtual phone number

virtualNumberCountrystring

Virtual number country code

followUpRolestring

Follow-up role: buyer_agent, listing_agent, etc.

agentExperiencestring

Agent experience description

emailstring

AI Assistant email

statusstring

Status: ACTIVE, INACTIVE, etc.

createdAtstring

Creation time in ISO8601 format

updatedAtstring

Last update time in ISO8601 format

hasQuotaSeatboolean

Whether AI has valid quota seat

borrowLevelstring

Borrow level if using borrowed AI: SELF, GROUP, TEAM

borrowIdinteger

Borrowed from user/office ID

Example response

{
  "id": 12345,
  "userId": 67890,
  "agentName": "John Doe",
  "agentHeadUrl": "https://example.com/avatar.jpg",
  "assistantName": "John's AI Assistant",
  "assistantHeadUrl": "https://example.com/ai-avatar.jpg",
  "virtualNumber": "+1234567890",
  "virtualNumberCountry": "US",
  "followUpRole": "buyer_agent",
  "agentExperience": "10 years in real estate",
  "email": "john.assistant@example.com",
  "status": "ACTIVE",
  "createdAt": "2026-02-20T10:00:00Z",
  "updatedAt": "2026-02-28T10:00:00Z",
  "hasQuotaSeat": true,
  "borrowLevel": "SELF",
  "borrowId": 12345
}