ENSign In
Referencia APIv1Customers

List customers

GET
/v1/customers

Authorization

X-API-Key<token>

Per-store API key created in the dashboard at Settings > Developer > API Keys.

In: header

Query Parameters

page?integer
Default1
Range1 <= value
per_page?integer
Default25
Range1 <= value <= 100
sort?string
Default"created_at"
Value in"name" | "created_at" | "updated_at" | "orders_count" | "total_spent" | "last_order_at"
order?string
Default"desc"
Value in"asc" | "desc"
search?string
total_spent[gte]?number

Minimum value for total_spent

Range0 <= value
total_spent[lte]?number

Maximum value for total_spent

Range0 <= value
orders_count[gte]?number

Minimum value for orders_count

Range0 <= value
orders_count[lte]?number

Maximum value for orders_count

Range0 <= value
last_order_at[gte]?string

Start of date range for last_order_at (ISO 8601)

Formatdate-time
last_order_at[lte]?string

End of date range for last_order_at (ISO 8601)

Formatdate-time
has_orders?string

When true, return only customers with at least one order. When false, only customers with zero orders.

Value in"true" | "false"

Response Body

application/json

curl -X GET "https://api.whatalo.com/v1/customers"
{
  "data": [
    {
      "id": "365047281936",
      "name": "María García",
      "email": "[email protected]",
      "phone": "+18091234567",
      "notes": "string",
      "has_email": true,
      "has_phone": true,
      "display_contact": "[email protected]",
      "created_at": "string",
      "updated_at": "string",
      "orders_count": 12,
      "total_spent": 1500.5,
      "last_order_at": "2026-04-15T14:30:00Z",
      "last_order_id": "order_pubid_xyz"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 100,
    "total_pages": 4
  }
}