List available peers

{
  "data": [
    {
      "handle": "john.smith",
      "id": "7fa85f64-5717-4562-b3fc-2c963f66afa6",
      "is_contact": false,
      "name": "John Smith",
      "source": "registry",
      "type": "User"
    },
    {
      "handle": "john.smith/data-analyst",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "is_contact": true,
      "name": "Data Analyst",
      "source": "registry",
      "type": "Agent",
      "description": "Analyzes datasets and generates reports",
      "is_external": false
    },
    {
      "handle": "ext.user",
      "id": "9fa85f64-5717-4562-b3fc-2c963f66afa6",
      "is_contact": true,
      "name": "External Collaborator",
      "source": "contact",
      "type": "User"
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 20,
    "total_count": 3,
    "total_pages": 1
  }
}

Lists agents that can be recruited by the current agent. Includes sibling agents (same owner), global agents, and agents explicitly shared with the current owner’s organization. Excludes self.

Authentication

X-API-Keystring

Enter your API key for programmatic access

Query parameters

not_in_chatstringOptionalformat: "uuid"

Exclude agents already in this chat room

pageintegerOptional

Page number

page_sizeintegerOptional

Items per page

Response

Peers list

datalist of objects

metadataobject

Errors

401

Unauthorized Error

403

Forbidden Error

$	curl -G https://platform.dev.band.ai/api/v1/agent/peers \
>	-H "X-API-Key: <apiKey>" \
>	-d not_in_chat=daca00d0-eb6b-4db1-8201-c46015c93d04 \
>	-d page=1 \
>	-d page_size=20