Background Agents

List Background Agents

Returns a list of all background agents in your organization.

Background agents are synthetic identities that run on external agent platforms (Claude Managed Agents, AWS AgentCore, or your own runtime) and call tools through the Willow gateway.

get/api/background-agents

Request

  • Base URL: https://app.withwillow.ai
  • URL: https://app.withwillow.ai/api/background-agents
  • Auth: HTTP bearer

Query parameters

searchstring

Case-insensitive search against agent name and slug.

owner_idstring

Only return agents owned by this user ID.

cursorinteger

Zero-based cursor offset for pagination. Pages contain up to 100 agents.

includeTotalboolean

Include the total number of matching agents in totalCount.

Response

List of background agents retrieved successfully

totalCountinteger

Total number of matching agents. Only present when includeTotal=true.

Example response

{
  "data": [
    {
      "id": "agent_abc123",
      "name": "Support Triage Agent",
      "slug": "support-triage-agent",
      "access_key": "ba_x1y2z3...",
      "sync_state": {
        "credential_id": "vcrd_01ABCDEfghijKLMNopqrSTUv",
        "vault_id": "vlt_01ABCDEfghijKLMNopqrSTUv"
      },
      "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Changes

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