v1

latestOpenAPI 3.1.02026-07-134488210.8 KB

Customers

Get customer by email

Retrieve a customer profile by email address.

The response includes the customer's name, contact information, location, and any custom fields associated with the profile. Custom fields are returned as { fieldName: value } pairs.

Requires the customers_read scope.

get/stores/{storeId}/customers

Path parameters

storeIdstring required

Example:64e5a8a1af49a89df37e4ee7

Store ID

Query parameters

emailstring email required

Customer email address

Response

Customer found

idstring required

Redo customer ID

emailstring email required

Customer email address

firstNamestring

Customer first name

lastNamestring

Customer last name

phoneNumberstring

Customer phone number in E.164 format

customFieldsobject

Custom field values as key-value pairs, where keys are field names and values can be strings, numbers, or booleans. DATE custom field values are returned as ISO 8601 datetime strings (e.g., "2026-01-15T12:00:00.000Z"), not Date objects.

createdAtstring date-time nullable

Timestamp when the customer was created. May be null for older customers created before this field was tracked.

updatedAtstring date-time nullable

Timestamp when the customer was last updated. May be null for older customers created before this field was tracked.

Example response

{
  "id": "67bd4f1a2e3c8d001a5f9b12",
  "email": "jane@example.com",
  "firstName": "Jane",
  "lastName": "Smith",
  "phoneNumber": "+11234567890",
  "location": {
    "state": "Washington",
    "stateCode": "WA",
    "postalCode": "12345",
    "country": "United States",
    "countryCode": "US",
    "ianaTimeZoneName": "America/New_York"
  },
  "customFields": {
    "subscription_source": "web",
    "status": "Active",
    "loyalty_points": 1250,
    "vip_member": true,
    "signup_date": "2026-02-24T12:15:00.000Z"
  },
  "createdAt": "2026-02-20T18:30:00.000Z",
  "updatedAt": "2026-02-24T12:15:00.000Z"
}