List Agents

Lists all active agents for the specified account. locationId is required parameter to ensure optimal performance. Supports pagination using limit and offset. Optionally filter by isPublished=true to return only agents with a published production version.

GET https://services.leadconnectorhq.com/agent-studio/agent

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Query parameters

string

default:"C2QujeCh8ZnC7al2InWR"

required

string

default:"true"

Optional filter to return only agents with a published production version

string

default:"20"

required

string

default:"0"

required

string

default:"api"

Respuestas

200 - Agents retrieved successfully

boolean

default:"True"

required

Success status

string

default:"Agents retrieved successfully"

required

Response message

object[]

required

List of agents with metadata

Show cada item

string

Agent ID

string

Agent name

string

Agent description

string

Account ID

string

Agent status (always “active”)

string

Creation timestamp

string

Last update timestamp

object

required

Pagination metadata

Show propiedades

number

Total number of agents

number

Number of agents per page

number

Starting position

boolean

Whether more agents exist

{
  "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

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

500 - Internal Server Error

number

default:"500"

string

default:"Internal Server Error"

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

Ejemplo

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

const response = await fetch('https://services.leadconnectorhq.com/agent-studio/agent', {
  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/agent-studio/agent',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/agent-studio/agent');
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);

Empezar

Scopes

Autorización

Query parameters

Respuestas

Ejemplo

​Autorización

​Query parameters

​Respuestas

​Ejemplo

Autorización

Query parameters

Respuestas

Ejemplo