Skip to main content
GET
/
v1
/
agents
/
full
List Agents (Full)
curl --request GET \
  --url https://api.xpander.ai/v1/agents/full \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.xpander.ai/v1/agents/full"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.xpander.ai/v1/agents/full', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.xpander.ai/v1/agents/full",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.xpander.ai/v1/agents/full"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.xpander.ai/v1/agents/full")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.xpander.ai/v1/agents/full")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "name": "<string>",
      "id": "<string>",
      "description": "<string>",
      "icon": "<string>",
      "model_provider": "<string>",
      "model_name": "<string>",
      "instructions": {
        "role": [],
        "goal": [],
        "general": ""
      },
      "knowledge_base_ids": [],
      "source_node_types": [],
      "tools": [],
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "created_by_details": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      }
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123,
  "total_pages": 123
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
Retrieve a paginated list of AI agents. Each item is the simplified agent view — core configuration plus a flat tools array (see Get Agent for the per-item field shape, including the AgentTool object). Low-level graph, attached_tools, and oas are not included; manage tools via the Tools API.

Query Parameters

page
integer
default:1
Page number (starting from 1)
per_page
integer
default:20
Items per page (maximum 50)

Response

Returns a paginated list of agents with complete details:
items
array
Array of complete agent objects
total
integer
Total number of agents across all pages
page
integer
Current page number
per_page
integer
Number of items per page
total_pages
integer
Total number of pages available

Example Request

curl -X GET -H "x-api-key: <your-api-key>" \
  "https://api.xpander.ai/v1/agents/full?page=1&per_page=2"

Example Response

{
  "items": [
    {
      "id": "<agent-id>",
      "unique_name": "product-specialist",
      "name": "Product Specialist",
      "description": "Processes queries to provide comprehensive product information",
      "icon": "🚀",
      "status": "ACTIVE",
      "organization_id": "<org-id>",
      "deployment_type": "serverless",
      "framework": "agno",
      "type": "manager",
      "created_at": "2026-02-05T18:35:04.724091Z",
      "created_by": "<user-id>",
      "created_by_details": {
        "id": "<user-id>",
        "name": "Jane Doe",
        "email": "jane@acme.com"
      },
      "model_provider": "openai",
      "model_name": "gpt-4.1",
      "instructions": {
        "role": [
          "You are a product specialist assistant"
        ],
        "goal": [
          "Provide accurate product information to customers"
        ],
        "general": "Be helpful and professional"
      },
      "tools": [
        {
          "id": "search-products",
          "name": "Search Products",
          "method": "get",
          "path": "/products/search"
        }
      ],
      "knowledge_bases": [],
      "graph": [],
      "access_scope": "organizational"
    }
  ],
  "total": 41,
  "page": 1,
  "per_page": 2,
  "total_pages": 21
}

Notes

  • This endpoint returns complete agent configurations, which may be slower than the minimal list endpoint
  • Use the minimal list endpoint (GET /v1/agents) if you only need basic agent information
  • The response is automatically filtered based on your API key’s permissions
  • Large responses may take longer to retrieve due to nested configurations

See Also

Authorizations

x-api-key
string
header
required

API Key for authentication

Query Parameters

page
integer
default:1

Page number (starting from 1)

Required range: x >= 1
per_page
integer
default:20

Items per page (max 50)

Required range: 1 <= x <= 50

Response

Successful Response

items
SimplifiedAIAgent · object[]
required
total
integer
required
page
integer
required
per_page
integer
required
total_pages
integer
required