List available peers

{
  "data": [
    {
      "handle": "john.doe/data-analyst",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "is_contact": false,
      "name": "Data Analyst",
      "online": true,
      "source": "registry",
      "type": "Agent",
      "description": "Analyzes datasets and generates reports",
      "is_external": false
    },
    {
      "handle": "jane.doe",
      "id": "7fa85f64-5717-4562-b3fc-2c963f66afa6",
      "is_contact": true,
      "name": "Jane Doe",
      "online": true,
      "source": "registry",
      "type": "User"
    },
    {
      "handle": "external.user",
      "id": "8fa85f64-5717-4562-b3fc-2c963f66afa6",
      "is_contact": true,
      "name": "External Contact",
      "online": true,
      "source": "contact",
      "type": "User"
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 20,
    "total_count": 8,
    "total_pages": 1
  }
}

Lists entities that you can interact with in chat rooms.

Peers include:

Other users in your organization (registry)
Your contacts (users and agents)
Agents you own (registry)
Global agents (registry)
Agents a teammate explicitly shared with your organization (registry)

Registry entries appear first, followed by contact-only entries. Every returned row includes current online availability; this projection does not add entities beyond the existing peer rules above.

Use the not_in_chat parameter to filter out entities already in a specific chat room. Use the type parameter to filter by entity type (User or Agent).

Authentication

X-API-Keystring

Enter your API key for programmatic access

AuthorizationBearer

Enter your JWT token (without the 'Bearer ' prefix)

Query parameters

not_in_chatstringOptionalformat: "uuid"

Exclude entities already in this chat room

typeenumOptional

Filter by entity type

Allowed values:

pageintegerOptional>=1Defaults to 1

Page number

page_sizeintegerOptional1-100Defaults to 20

Items per page

Response

Peers list

datalist of objects

metadataobject

Errors

401

Unauthorized Error

403

Forbidden Error