Deprecated endpoint - use GET /agent instead.

Lists all active agents that have a published production version for the specified account. locationId is required parameter. Supports pagination using limit and offset.

http
GET https://services.leadconnectorhq.com/agent-studio/public-api/agents

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Query parameters

NameTypeRequiredExampleDescription
locationIdstringYesC2QujeCh8ZnC7al2InWR
limitstringYes20
offsetstringYes0
sourcestringNoapi

Responses

200 - Agents retrieved successfully
  • success (boolean, required): Success status Example: True

  • message (string, required): Response message Example: Agents retrieved successfully

  • agents (object[], required): List of agents with metadata

    • agentId (string): Agent ID

    • name (string): Agent name

    • description (string): Agent description

    • locationId (string): Account ID

    • status (string): Agent status (always "active")

    • createdAt (string): Creation timestamp

    • updatedAt (string): Last update timestamp

  • pagination (object, required): Pagination metadata

    • total (number): Total number of agents

    • limit (number): Number of agents per page

    • offset (number): Starting position

    • hasMore (boolean): Whether more agents exist

json
{
  "success": true,
  "message": "Agents retrieved successfully",
  "agents": [
    {
      "agentId": "p1q2r3s4t5u6v7w8x9y0z1a2",
      "name": "Marketing Assistant",
      "description": "AI agent specialized in marketing strategy and content creation",
      "locationId": "C2QujeCh8ZnC7al2InWR",
      "status": "active",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-02-20T14:45:00.000Z"
    },
    {
      "agentId": "b3c4d5e6f7g8h9i0j1k2l3m4",
      "name": "Customer Support Bot",
      "description": "AI agent for handling customer inquiries and support tickets",
      "locationId": "C2QujeCh8ZnC7al2InWR",
      "status": "active",
      "createdAt": "2024-01-10T09:15:00.000Z",
      "updatedAt": "2024-02-18T16:20:00.000Z"
    }
  ],
  "pagination": {
    "total": 25,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}
400 - Bad Request - locationId is required
json
{}
401 - Unauthorized
json
{}
422 - Unprocessable Entity
json
{}
500 - Internal Server Error
  • statusCode (number): Example: 500

  • message (string): Example: Internal Server Error

json
{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Example

curl -X GET 'https://services.leadconnectorhq.com/agent-studio/public-api/agents' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

Last updated October 26, 2026

Was this page helpful?