Get customer by email address
GET/api/v1/customers/by-email/:email
This endpoint retrieves customer information by email address. Useful for customer lookup and email-based operations.
Authentication: Requires a Private API Key (sk_*) passed in the X-API-Key header.
Email Format: Must be a valid email address format
Use Cases:
- Customer lookup during email-based checkout flows
- Email marketing and communication workflows
- Customer support and account recovery
- CRM integration via email identifier
Error Scenarios:
- 404 NOT FOUND: Customer with this email doesn't exist (Error code: CUSTOMER_NOT_FOUND)
- 400 BAD REQUEST: Invalid email format (Error code: INVALID_EMAIL_FORMAT)
- 401 UNAUTHORIZED: Invalid or missing API key (Error code: INVALID_API_KEY)
- 403 FORBIDDEN: API key doesn't have access to this store (Error code: NO_STORE_ACCESS)
Request​
Responses​
- 200
- 400
- 401
- 403
- 404
- 500
Customer found and returned successfully
Invalid email format
Unauthorized - Invalid or missing API key
Forbidden - No access to this store
Customer not found
Internal server error