Getting Started

Sections

Theme switcher

Find Customer by Email

Header Parameters

x-client-idstring
x-signaturestring
Authorizationstring
x-timestampstring
Content-Typestring

Query Parameters

emailstring Required

The email address to search for. Must be an exact match (case-insensitive).

Special characters should be URL-encoded.

Response

200
Object
Customer found

Response Attributes

statusstring
messagestring
dataobject

Show child attributes

400
Object
Bad Request - Invalid or missing email parameter

Response Attributes

statusstring Required

Always "error" for error responses

messagestring Required

Human-readable error description

codestring Required

Machine-readable error code for programmatic handling

detailsobject

Additional context about the error (varies by error type)

Show child attributes

errorsarray

Present for validation errors with multiple fields

Show child attributes

401
Object
Unauthorized - Authentication failed

Response Attributes

statusstring Required

Always "error" for error responses

messagestring Required

Human-readable error description

codestring Required

Machine-readable error code for programmatic handling

detailsobject

Additional context about the error (varies by error type)

Show child attributes

errorsarray

Present for validation errors with multiple fields

Show child attributes

404
Object
Not Found - Customer does not exist

Response Attributes

statusstring Required

Always "error" for error responses

messagestring Required

Human-readable error description

codestring Required

Machine-readable error code for programmatic handling

detailsobject

Additional context about the error (varies by error type)

errorsarray

Present for validation errors with multiple fields

Show child attributes

429
Object
Too Many Requests - Rate limit exceeded

Response Attributes

statusstring Required

Always "error" for error responses

messagestring Required

Human-readable error description

codestring Required

Machine-readable error code for programmatic handling

detailsobject

Additional context about the error (varies by error type)

Show child attributes

errorsarray

Present for validation errors with multiple fields

Show child attributes

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot