Skip to main content
GET
/
v1
/
customers
List customers with analytics
curl --request GET \
  --url http://localhost:3000/v1/customers
{
  "customers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "full_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "created_at": "<string>",
      "analytics": {
        "total_orders": 123,
        "total_spend": 123,
        "average_order_value": 123,
        "orders_pending": 123,
        "orders_completed": 123,
        "orders_cancelled": 123,
        "first_order_at": "<string>",
        "last_order_at": "<string>",
        "price_sensitivity_score": 123
      }
    }
  ],
  "total": 123
}

Query Parameters

limit
integer
default:20

Max items to return

Required range: 1 <= x <= 100
Example:

20

offset
integer | null
default:0

Items to skip

Required range: x >= 0
Example:

0

Search query

Maximum string length: 200
Example:

"john"

sortBy
enum<string>
default:created_at

Sort field

Available options:
total_spend,
total_orders,
last_order,
created_at
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

List of customers

List customers response

customers
object[]
required
total
number
required