Agents

List agents

Retrieve a paginated list of agents for the authenticated organization

get/agents

Request

  • Base URL: https://api.weav.com/v1
  • URL: https://api.weav.com/v1/agents
  • Auth: HTTP bearer

Query parameters

per_pageinteger

Number of results per page (max 100)

pageinteger

Page number

Response

Successful operation

linksobject
metaobject

Example response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Agent",
      "slug": "agent",
      "description": "Helps customers with support queries",
      "avatar_url": "https://example.com/avatar.png",
      "max_messages_per_session": 50,
      "tone": "professional",
      "response_length": "standard",
      "is_active": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.