Cowdidocs
API ReferenceAgents

List the customer's account summaries

GET
/v1/agents/{userId}/customers/{customerId}/accounts

List a customer's accounts with balance, type, status, and currency. Requires the org:agents:read permission. Available to the agent the customer is assigned to and to that agent's supervisor chain. Returns 404 when the agent or the customer does not exist, or the customer is not currently assigned to the agent.

Authorization

oauth2
AuthorizationBearer <token>

Create a client with POST /v1/oauth/clients, then exchange its credentials for an access token. AUTHORIZATION_CODE clients act on behalf of a signed-in user and always use PKCE; CLIENT_CREDENTIALS clients act as themselves. A client may only be granted scopes its creator already holds — read the grantable list from GET /v1/oauth/clients/scopes.

In: header

Path Parameters

userId*string

ID of the agent the customer is assigned to.

Formatuuid
customerId*string

ID of the customer whose accounts to list.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agents/550e8400-e29b-41d4-a716-446655440000/customers/550e8400-e29b-41d4-a716-446655440001/accounts"
[  {    "id": "550e8400-e29b-41d4-a716-446655440000",    "account_number": "00123458",    "type": "CURRENT",    "status": "ACTIVE",    "available_balance": 0,    "currency": "KES",    "resource_id": "string"  }]
{  "code": "BAD_REQUEST",  "description": "Bad Request"}
{  "code": "UNAUTHORISED",  "description": "Unauthorised"}
{  "code": "FORBIDDEN",  "description": "Forbidden"}
{  "code": "BAD_REQUEST",  "description": "Invalid input"}
{  "code": "RATE_LIMIT_EXCEEDED",  "description": "Too Many Requests"}
{  "code": "INTERNAL_ERROR",  "description": "Internal Server Error"}

Assign customers to the agent POST

Assign one or more customers to an agent. Requires the `org:agents:write` permission. The agent must be visible to the caller and able to take new customers. Each customer must exist in the organization. Returns 404 when the agent or a customer does not exist. Returns 403 when the agent can't take new customers or a customer is already assigned to a different agent.

List the agent's customer assignment history GET

List every customer assignment and unassignment for one agent, newest first. Requires the `org:agents:read` permission. Available under the same visibility rule as `GET /v1/agents/{userId}`. Returns 404 when the agent does not exist or is outside the caller's visibility.