Skip to main content

Method Signature

Parameters

string
Optional email address to filter results. Use for exact-match lookups.

Returns

Customer[]
Array of customer objects matching the query

Examples

List All Customers

Find Customer by Email

Use the email filter to find a specific customer:

Check if Customer Exists

Useful for preventing duplicate registrations:

Response Example

The email filter performs an exact match. For partial matches, retrieve all customers and filter client-side.

Create Customer

Create a new customer

Get Customer

Get a specific customer by ID