End customers
List End Customers
Required permission
customer:readGET
The Platform's End Customers, newest first, with each one's onboarding state and standing.
Requires the customer:read permission.
ApiKeyheader
AuthorizationBearer <API key>A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.
state?stringOnly End Customers in this state.
Value in
"profile_pending""profile_review""provider_onboarding""active""suspended""rejected"q?stringOnly End Customers whose legal name or email contains this text.
limit?integerHow many End Customers to answer.
Range
1 <= value <= 500Default
50offset?integerHow many to skip, for the next page.
Range
0 <= valueDefault
0OK
application/json- response
[index: integer]?curl -X GET 'http://localhost:3480/v1/end-customers'Example Response
[ { "country": "PK", "created_at": "2026-11-10T14:05:00Z", "email": "lina@example.com", "has_people": false, "id": "3f6c2a9e-8b1d-4c7a-9e2f-5a6b7c8d9e0f", "legal_name": "Lina Qureshi", "providers": [ { "provider": "bvnk", "state": "approved" } ], "standing": "active", "state": "active", "suspended_by": "operator", "suspended_reason": "string", "type": "individual", "updated_at": "2026-11-11T10:20:00Z" }]