humanApiPeers

List available peers

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.

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

get/api/v1/me/peers

Query parameters

not_in_chatstring uuid

Exclude entities already in this chat room

type'User' | 'Agent'

Filter by entity type

pageinteger

Page number

page_sizeinteger

Items per page

Headers

X-API-Keystring required

Enter your API key for programmatic access

Response

Peers list

PeersListMyPeersResponse200 required— unresolved $ref

Changes