List Agents (Full Details)

List Agents (Full)

curl --request GET \
  --url https://api.xpander.ai/v1/agents/full \
  --header 'x-api-key: <api-key>'

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))

}

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": [
    {
      "id": "a1a1a1a1-b2b2-c3c3-d4d4-e5e5e5e5e5e5",
      "name": "Research Assistant",
      "description": "Searches the web and reports findings as JSON.",
      "icon": "🚀",
      "status": "ACTIVE",
      "organization_id": "0a0a0a0a-1b1b-2c2c-3d3d-4e4e4e4e4e4e",
      "deployment_type": "serverless",
      "model_provider": "anthropic",
      "model_name": "claude-sonnet-5",
      "type": "manager",
      "created_at": "2026-07-28T20:55:54.042725Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20,
  "total_pages": 1
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

agents

full

List Agents (Full)

curl --request GET \
  --url https://api.xpander.ai/v1/agents/full \
  --header 'x-api-key: <api-key>'

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))

}

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": [
    {
      "id": "a1a1a1a1-b2b2-c3c3-d4d4-e5e5e5e5e5e5",
      "name": "Research Assistant",
      "description": "Searches the web and reports findings as JSON.",
      "icon": "🚀",
      "status": "ACTIVE",
      "organization_id": "0a0a0a0a-1b1b-2c2c-3d3d-4e4e4e4e4e4e",
      "deployment_type": "serverless",
      "model_provider": "anthropic",
      "model_name": "claude-sonnet-5",
      "type": "manager",
      "created_at": "2026-07-28T20:55:54.042725Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20,
  "total_pages": 1
}

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

integer

default:1

Page number (starting from 1)

integer

default:20

Items per page (maximum 50)

Response

Returns a paginated list of agents with complete details:

array

Array of complete agent objects

Show Agent Object

string

Unique identifier for the agent (UUID format)

string

URL-safe unique name for the agent

string

Display name of the agent

string

Detailed description of the agent’s purpose and capabilities

string

Emoji icon representing the agent

string

Current deployment status: ACTIVE, INACTIVE

string

Organization UUID this agent belongs to

string

Deployment method: serverless, container, or null

string

Agent framework used (e.g., agno)

string

Agent type: manager, regular, a2a, curl, or orchestration

string

ISO timestamp of when the agent was created

string | null

UUID of the user who created the agent

object | null

Resolved creator details, one per agent item — no extra request needed. null when created_by is empty or the user cannot be resolved — null-check before reading sub-fields.

Show Created By Details

string

User UUID

string

Display name — first + last name. Falls back to email, then id, when the name is missing. Not guaranteed to be a real first/last name.

string

User email

object

Complete system instructions configuration with role, goal, and general fields

string

LLM provider: openai, anthropic, etc.

string

Specific model version (e.g., gpt-4o, gpt-4.1)

array

Array of tool configurations attached to this agent

array

Array of knowledge base IDs attached to this agent

array

Visual graph representation of agent’s tool and MCP connections

string

Access control scope: organizational, team, or private

integer

Total number of agents across all pages

integer

Current page number

integer

Number of items per page

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

Overview

REST API - Agents

REST API - Scheduled Tasks

REST API - Self-Schedules

Agent Workspace

REST API - Agent Gateway

REST API - Tasks

REST API - Knowledge

REST API - Workflows

REST API - Tools

REST API - Custom Functions

REST API - Misc

List Agents (Full Details)

Query Parameters

Response

Example Request

Example Response

Notes

See Also

Authorizations

Query Parameters

Response

​Query Parameters

​Response

​Example Request

​Example Response

​Notes

​See Also

Authorizations

Query Parameters

Response

Query Parameters

Response

Example Request

Example Response

Notes

See Also