API ReferenceAgents
Get my agent dashboard
Rollup of the authenticated agent's directly assigned customers: total/active/inactive/overdue counts and a repayment rate over a configurable window.
Query Parameters
inactive_threshold_days?integer
Days without a disbursement before a customer is INACTIVE
Format
int32repayment_window_days?integer
Days back from today over which to compute repayment rate (1-365)
Format
int32Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/agents/me/dashboard?inactive_threshold_days=60&repayment_window_days=90"{ "total_customer_count": 0, "active_customer_count": 0, "inactive_customer_count": 0, "overdue_customer_count": 0, "repayment_rate": 0.83, "repayment_window_days": 90, "inactive_threshold_days": 60}{ "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"}List my team's customers GET
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 my agent profile GET
Get the authenticated user's agent profile.