Cowdidocs
API ReferenceAgents

List my team's customers

List customers assigned to you and the agents you manage. Supports search by customer name, phone number, or email. Use exclude_agent_user_id to hide your own customers (useful when looking for customers to transfer).

GET
/v1/agents/me/customers

Query Parameters

size?integer

Page size

Range0 < value
Default20
after?string

Next page cursor

before?string

Previous page cursor

q?string

Search query (name, phone, email)

activity_status?string

Value in

  • "ACTIVE"
  • "INACTIVE"
  • "OVERDUE"
inactive_threshold_days?integer

Days without a disbursement before a customer is considered inactive. Used by ACTIVE and INACTIVE filters.

Default60
exclude_agent_user_id?string

Exclude customers assigned to this agent

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agents/me/customers"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "agent_user_id": "10fd0551-5cc1-4920-817b-63bd803087a9",      "agent_user_name": "string",      "agent_phone_number": "string",      "agent_email": "string",      "customer_user_id": "de115842-addf-4f11-bee7-4b415ab13852",      "customer_name": "string",      "customer_email": "string",      "customer_phone_number": "string",      "assigned_at": "2019-08-24T14:15:22Z",      "unassigned_at": "2019-08-24T14:15:22Z",      "assigned_by": "dd7cba77-7080-4b0e-9a94-fdfd1232f6b4",      "unassigned_by": "9c8c9aa1-d188-4bc9-b19f-00452d95698d",      "assignment_reason": "string",      "unassignment_reason": "string",      "is_active": true,      "resource_id": "string"    }  ],  "links": {    "next": "string",    "prev": "string"  }}
{  "code": "BAD_REQUEST",  "description": "Bad Request"}
{  "code": "UNAUTHORISED",  "description": "Unauthorised"}
{  "code": "WAITING_LIST",  "description": "User is in the waiting list"}
{  "code": "TOO_MANY_REQUESTS",  "description": "Too Many Requests"}
{  "code": "INTERNAL_SERVER_ERROR",  "description": "Internal Server Error"}

Get insights for one of my customers GET

Aggregate insights (account count, overdue installments, total outstanding, last installment, derived activity status) for a customer assigned to you or to an agent you supervise.

Get my agent dashboard GET

Rollup of the authenticated agent's directly assigned customers: total/active/inactive/overdue counts and a repayment rate over a configurable window.