Searches for AI agents based on various criteria including name, status, and configuration. Supports advanced filtering and full-text search capabilities.
Searches for AI agents based on various criteria including name, status, and configuration. Supports advanced filtering and full-text search capabilities.
http
GET https://services.leadconnectorhq.com/conversation-ai/agents/search
Authorization
Name
Type
Required
Example
Description
Authorization
string
Yes
Bearer token generated from the Leadway portal. See Authentication.
Version
string
Yes
2021-07-28
API version.
Query parameters
Name
Type
Required
Example
Description
startAfter
string
No
Exampleee123
Start after is the agent id to start after, Serving as skip, send empty when first page
limit
number
No
1
Records per page
query
string
No
booking
query to search on agent name, must be provided in lowercase
Responses
200 - Successful response
agents (object[], required): List of agents matching the search criteria.
id (string, required): Unique identifier for the agent. Example: emp_123
name (string, required): Name of the agent. Example: John Doe
businessName (string): Name of the business the agent represents. Example: Tech Corp
mode (string, required): Current operating mode of the agent. Possible values: 'off', 'suggestive', 'auto-pilot' Example: auto-pilot
channels (string[], required): Communication channels the agent operates on.
waitTime (number, required): Wait time before agent responds. Example: 30
waitTimeUnit (string, required): Unit for wait time. Possible values: 'minutes', 'seconds' Example: seconds
sleepEnabled (boolean, required): Indicates if sleep functionality is enabled. Example: False
sleepTime (number): Duration of sleep period. Example: 2
sleepTimeUnit (string): Unit of sleep time. Possible values: 'hours', 'minutes', 'seconds' Example: hours
actions (object[], required): List of actions associated with this agent.
isPrimary (boolean, required): Indicates if this agent is a primary agent. (First agent created for a account is primary by default) Example: False
autoPilotMaxMessages (number, required): Maximum number of messages in auto-pilot mode before requiring human intervention. Example: 25
goal (object): Goal configuration for the agent.
knowledgeBaseIds (string[]): Array of knowledge base IDs associated with this agent.
createdAt (string, required): Timestamp when the agent was created. Example: 2024-01-01T00:00:00Z
updatedAt (string, required): Timestamp when the agent was last updated. Example: 2024-01-01T00:00:00Z
sleepOnManualMessage (boolean): Whether the bot sleeps on manual outbound messages. Example: False
sleepOnWorkflowMessage (boolean): Whether the bot sleeps on workflow outbound messages. Example: False
totalCount (number, required): Total number of agents in the account (unfiltered count). Example: 100
count (number, required): Number of agents in the current response (filtered/paginated count). Example: 25