Skip to main content
Searches for AI agents based on various criteria including name, status, and configuration. Supports advanced filtering and full-text search capabilities. 
GET https://services.leadconnectorhq.com/conversation-ai/agents/search

​
Autorización

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticación.
​
Version
string
default:"2021-07-28"
required
Versión de la API.

​
Query parameters

​
startAfter
string
default:"Exampleee123"
Start after is the agent id to start after, Serving as skip, send empty when first page
​
limit
number
default:"1"
Records per page
​
query
string
default:"booking"
query to search on agent name, must be provided in lowercase

​
Respuestas

​
agents
object[]
required
List of agents matching the search criteria.
​
totalCount
number
default:"100"
required
Total number of agents in the account (unfiltered count).
​
count
number
default:"25"
required
Number of agents in the current response (filtered/paginated count).
{
  "agents": [
    {
      "id": "emp_123",
      "name": "John Doe",
      "businessName": "Tech Corp",
      "mode": "auto-pilot",
      "channels": [
        "SMS",
        "LIVE_CHAT"
      ],
      "waitTime": 30,
      "waitTimeUnit": "seconds",
      "sleepEnabled": false,
      "sleepTime": 2,
      "sleepTimeUnit": "hours",
      "actions": [
        {
          "id": "action_123",
          "type": "triggerWorkflow"
        }
      ],
      "isPrimary": false,
      "autoPilotMaxMessages": 25,
      "goal": {
        "prompt": "Assist customers",
        "type": "custom",
        "actionId": null
      },
      "knowledgeBaseIds": [
        "kb_123",
        "kb_456"
      ],
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "sleepOnManualMessage": false,
      "sleepOnWorkflowMessage": false
    }
  ],
  // truncado: 3 lineas mas
}

{}

{}

{}

​
Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/conversation-ai/agents/search' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/conversation-ai/agents/search', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();

import os, requests
response = requests.request(
    'GET',
    'https://services.leadconnectorhq.com/conversation-ai/agents/search',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/conversation-ai/agents/search');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);