Skip to main content
GET
/
v2.0
/
sales-agent
/
settings
Query Sales Agent settings
curl --request GET \
  --url https://api.lofty.com/v2.0/sales-agent/settings \
  --header 'Authorization: <authorization>'
{
  "id": 12345,
  "assistantName": "Anna",
  "headUrl": "https://example.com/avatar.jpg",
  "virtualNumber": "+1234567890",
  "virtualNumberCountry": "US",
  "callTransferType": "Disabled",
  "fixedNumber": "+1234567890",
  "agentExperience": "10 years in real estate",
  "rentalBusiness": false,
  "websiteChannel": true,
  "textChannel": true,
  "emailChannel": true,
  "startActiveHour": 8,
  "endActiveHour": 20,
  "activeDays": [
    1,
    2,
    3,
    4,
    5
  ],
  "leadTypes": [
    1,
    2
  ],
  "leadSources": [
    1001,
    1002
  ],
  "leadPipelines": [
    2001,
    2002
  ],
  "agentIds": [
    101,
    102
  ],
  "officeIds": [
    201,
    202
  ],
  "leadPondIds": [
    301,
    302
  ],
  "newLeadEnable": true,
  "visitorsEnable": true,
  "followUpRole": "AI",
  "hostedStatus": "ACTIVE"
}

Documentation Index

Fetch the complete documentation index at: https://developer.lofty.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
required

Bearer [access_token]

Response

Settings retrieved successfully.

Sales agent setting response

​
id
integer<int64>

AI Assistant ID

Example:

12345

​
assistantName
string

Assistant name

Example:

"Anna"

​
headUrl
string

Assistant avatar URL

Example:

"https://example.com/avatar.jpg"

​
virtualNumber
string

Virtual phone number

Example:

"+1234567890"

​
virtualNumberCountry
string

Virtual number country

Example:

"US"

​
callTransferType
string

Call transfer type: Disabled, ToAssignedAgent

Example:

"Disabled"

​
fixedNumber
string

Fixed phone number

Example:

"+1234567890"

​
agentExperience
string

Agent experience description

Example:

"10 years in real estate"

​
rentalBusiness
boolean

Whether agent handles rental business

Example:

false

​
websiteChannel
boolean

Whether website channel is enabled

Example:

true

​
textChannel
boolean

Whether text channel is enabled

Example:

true

​
emailChannel
boolean

Whether email channel is enabled

Example:

true

​
startActiveHour
integer<int32>

Active start hour (0-23)

Example:

8

​
endActiveHour
integer<int32>

Active end hour (0-23)

Example:

20

​
activeDays
integer<int32>[]

Active days of week (0=Sun, 6=Sat)

Example:
[1, 2, 3, 4, 5]
​
leadTypes
integer<int32>[]

Lead types filter

Example:
[1, 2]
​
leadSources
integer<int64>[]

Lead source IDs filter

Example:
[1001, 1002]
​
leadPipelines
integer<int64>[]

Lead pipeline IDs filter

Example:
[2001, 2002]
​
agentIds
integer<int64>[]

Agent IDs with access

Example:
[101, 102]
​
officeIds
integer<int64>[]

Office IDs with access

Example:
[201, 202]
​
leadPondIds
integer<int64>[]

Lead pond IDs with access

Example:
[301, 302]
​
newLeadEnable
boolean

Whether new lead follow-up is enabled

Example:

true

​
visitorsEnable
boolean

Whether visitor follow-up is enabled

Example:

true

​
followUpRole
string

Follow up role: AI or Agent

Example:

"AI"

​
hostedStatus
string

Hosted status

Example:

"ACTIVE"