Simiz automatically creates and updates customer profiles when transactions occur. Use the Customers API to search, filter, and view transaction history per customer.
API reference
Base path: /api/v1/projects/{projectId}/customers
Available endpoints
| Method | Endpoint | Description |
|---|
GET | / | List all customers (with filters) |
GET | /stats | Get customer statistics |
GET | /{customerId} | Get a single customer |
GET | /{customerId}/transactions | Get customer’s transaction history |
Customers are created automatically when a transaction includes a customerId. There is no manual create endpoint — customers emerge from your transaction flow.
List customers with filters
GET /api/v1/projects/{projectId}/customers?search=237690&page=1&per_page=20&sort_by=lastTransactionAt&sort_order=desc
Filter parameters
| Parameter | Type | Default | Description |
|---|
search | string | — | Search by phone, email, or name |
page | number | 1 | Page number |
per_page | number | 20 | Items per page (1-100) |
sort_by | string | lastTransactionAt | Sort field |
sort_order | string | desc | asc or desc |
Get customer transactions
GET /api/v1/projects/{projectId}/customers/{customerId}/transactions?page=1&per_page=20
Customer fields
Each customer profile includes:
| Field | Type | Description |
|---|
id | UUID | Unique customer ID |
projectId | UUID | Associated project |
externalId | string | Your own customer identifier (optional) |
email | string | Customer email (optional) |
phone | string | Customer phone (optional) |
name | string | Customer name (optional) |
metadata | object | Custom key-value data |
totalTransactions | number | Total number of transactions |
totalSpent | decimal | Total amount spent |
lastTransactionAt | datetime | Last transaction timestamp |
createdAt | datetime | Customer creation date |
updatedAt | datetime | Last update date |
