v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Sales Agents V2

Query Sales Agent settings

Returns the Sales Agent settings configured for the current caller.

get/v2.0/sales-agent/settings

Headers

Authorizationstring required

Bearer [access_token]

Response

Settings retrieved successfully.

idinteger

AI Assistant ID

assistantNamestring

Assistant name

headUrlstring

Assistant avatar URL

virtualNumberstring

Virtual phone number

virtualNumberCountrystring

Virtual number country

callTransferTypestring

Call transfer type: Disabled, ToAssignedAgent

fixedNumberstring

Fixed phone number

agentExperiencestring

Agent experience description

rentalBusinessboolean

Whether agent handles rental business

websiteChannelboolean

Whether website channel is enabled

textChannelboolean

Whether text channel is enabled

emailChannelboolean

Whether email channel is enabled

startActiveHourinteger

Active start hour (0-23)

endActiveHourinteger

Active end hour (0-23)

activeDaysinteger[]

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

leadTypesinteger[]

Lead types filter

leadSourcesinteger[]

Lead source IDs filter

leadPipelinesinteger[]

Lead pipeline IDs filter

agentIdsinteger[]

Agent IDs with access

officeIdsinteger[]

Office IDs with access

leadPondIdsinteger[]

Lead pond IDs with access

newLeadEnableboolean

Whether new lead follow-up is enabled

visitorsEnableboolean

Whether visitor follow-up is enabled

followUpRolestring

Follow up role: AI or Agent

hostedStatusstring

Hosted status

Example response

{
  "id": 12345,
  "assistantName": "Anna",
  "headUrl": "https://example.com/avatar.jpg",
  "virtualNumber": "+1234567890",
  "virtualNumberCountry": "US",
  "callTransferType": "Disabled",
  "fixedNumber": "+1234567890",
  "agentExperience": "10 years in real estate",
  "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"
}