Compose Finance
Customers

List customers

Returns all customers for the authenticated organization. Requires Bearer token authentication.

GET
/api/v2/customers

Returns all customers for the authenticated organization. Requires Bearer token authentication.

Authorization

bearerAuth
AuthorizationBearer <token>

Organization API key obtained from PropelAuth

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET 'https://compose.finance/api/v2/customers' \  -H 'Authorization: Bearer YOUR_API_KEY'
[
  {
    "customerId": "550e8400-e29b-41d4-a716-446655440001",
    "email": "[email protected]",
    "name": "JOHN DOE",
    "accountType": "individual",
    "expectedMonthlyVolume": 25000
  },
  {
    "customerId": "550e8400-e29b-41d4-a716-446655440002",
    "email": "[email protected]",
    "name": "JANE SMITH",
    "accountType": "individual",
    "expectedMonthlyVolume": 75000
  },
  {
    "customerId": "550e8400-e29b-41d4-a716-446655440003",
    "email": "[email protected]",
    "name": "BOB WILSON",
    "accountType": "individual",
    "expectedMonthlyVolume": 10000
  }
]
{
  "error": "Unauthorized - Invalid or missing API key or session"
}
{
  "error": "Customers feature is not enabled for your organization"
}
{
  "error": "Internal server error"
}