Sign in
Agents

List agents

Agents in your organization. An agent key sees only itself.

get/v1/agents

Query parameters

limitnumber

Number of results to return (1-1000). Use with offset for traditional pagination.

offsetnumber

Number of results to skip. Use with limit for traditional pagination.

page_sizenumber

Number of results per page (1-1000). Use with starting_after for cursor-based pagination.

starting_afterstring

Cursor for pagination. Use the ID of the last item from the previous page to get the next page. Use with page_size for cursor-based pagination.

customerIdstring
Example:cus_abc123

Filter by principal customer

status'ACTIVE' | 'PAUSED' | 'REVOKED'

Headers

X-API-Keystring

API key

Response

totalnumber
limitnumber
offsetnumber

Example response

{
  "data": [
    {
      "id": "agt_abc123",
      "name": "Procurement Agent",
      "description": "Buys supplies",
      "customerId": "cus_abc123",
      "sourceAccountId": "vba_agent_balance",
      "allowedDestinationAccountIds": [
        "eba_vendor456"
      ],
      "limits": {
        "currency": "USD",
        "perTransaction": "100000",
        "perDay": "500000",
        "perMonth": "1000000"
      }
    }
  ]
}

Changes