Customers API

Access customer profiles and data.

Overview

Manage customer profiles, addresses, and preferences via the API.

Endpoints

MethodPathDescription
GET/api/admin/customersList customers with search, sort, and pagination
POST/api/admin/customersCreate a new customer
GET/api/admin/customers/[id]Get customer with orders and addresses
PUT/api/admin/customers/[id]Update customer profile
DELETE/api/admin/customers/[id]Delete a customer (Owner only)

Query parameters

  • search β€” search by name, email, or phone
  • sort β€” sort by totalSpent, orderCount, createdAt, or name
  • marketing β€” filter by marketing consent (email, sms)

Was this article helpful?

Customers API β€” Profile & Data Endpoints | KATURA