API: customers and events

Back officeUpdated 2 November 2026

Customers are the business's — one list for every shop.

Read customers

GET /api/developer/v1/customers?search=meena&after=0&limit=50
GET /api/developer/v1/customers/42

The key needs Customers · Read. Each has id, name, email, phone, active, createdAt and updatedAt — never what they spent.

Add or change a customer

POST /api/developer/v1/customers
{ "shop": "ADY001", "name": "Meena", "phone": "9840011223", "email": "[email protected]" }

PATCH /api/developer/v1/customers/42
{ "shop": "ADY001", "name": "Meena Krishnan" }

The key needs Customers · Add and change. A phone number already on file is refused with 409, naming who has it. Only the name, phone and email can be changed.

Tell Marketing what a customer did

POST /api/developer/v1/events
{ "contactId": 42, "kind": "page.viewed", "properties": { "url": "https://shop.example.com/rice" }, "idempotencyKey": "view-8812" }

The key needs Customer events · Send in, and the business needs Marketing. The same idempotencyKey is recorded once.