List Customers

Retrieve all customers associated with the current active business.

GET /v1/customers

TypeScript SDK

TypeScript

import { Solifyn } from 'solifyn';

const solifyn = new Solifyn({ apiKey: 'your_private_api_key_here' });

// List business customers
const customers = await solifyn.customers.list({
  limit: 20
});
console.log('Customers:', customers);

200

{
  "items": [
    {
      "id": "user_123",
      "email": "[e-mail]",
      "createdAt": "2025-01-01T12:00:00Z",
      "updatedAt": "2025-01-01T12:00:00Z",
      "businessId": "537825c3-14d6-4173-b072-33f921416efc",
      "memberId": "mem_123",
      "name": "John Doe",
      "username": "johndoe",
      "phone": "[phone]",
      "phone_number": "[phone]",
      "metadata": {
        "key": "value"
      }
    }
  ],
  "total_count": 1
}

Authorizations

Authorization · string · header · required

Authenticate requests using your standard bearer API key (e.g. YOUR_API_KEY).

Response

200 - application/json

List of customers retrieved successfully.

items · object[] · required

List of customers

Show child attributes

total_count · number · required

Total count of customers matching the filters

Example:

1