> For the complete documentation index, see [llms.txt](https://the-wishlist-documentation.gitbook.io/the-wishlist-documentation-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://the-wishlist-documentation.gitbook.io/the-wishlist-documentation-docs/customer-rest-api/customers/lookupcustomer.md).

# lookupCustomer

Returns a list of customers with a matching ***email***, ***mobile***, ***phone***, ***firstName***, and/or ***lastName***. A record is returned only if **all** of the given criteria are matched. If no customers exist, this method returns a empty list.

```json
{"openapi":"3.0.3","info":{"title":"Customer REST API","version":"0.0.1"},"tags":[{"name":"customers","description":"Create, read, update and delete customers, and look them up by id, reference, email or alternate reference."}],"servers":[{"url":"https://api.au-aws.thewishlist.io/services/customerservice"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"OAuth2 bearer token issued by TWC Keycloak, sent as `Bearer <token>`."}},"parameters":{"email":{"name":"email","in":"query","required":false,"description":"The customer's email address","schema":{"type":"string"}},"firstName":{"name":"firstName","in":"query","required":false,"description":"The customer's first name","schema":{"type":"string"}},"lastName":{"name":"lastName","in":"query","required":false,"description":"The customer's last name","schema":{"type":"string"}},"mobile":{"name":"mobile","in":"query","required":false,"schema":{"type":"string"}},"pageSize":{"name":"pageSize","in":"query","required":false,"description":"Determines the number of wishlist items returned in the API response. Default page size is 20 and max is 50.","schema":{"type":"string"}},"lastItemId":{"name":"lastItemId","in":"query","required":false,"description":"Determines which items to return. API returns wishlist items in the ascending order of their TWC generated wishlist ID. This parameter will inform the API to respond with items that have ID greater than, but excluding the value provided.","schema":{"type":"string"}},"X-TWC-Tenant":{"name":"X-TWC-Tenant","in":"header","required":false,"description":"tenant-key (your retail store's unique identifier in TWC)","schema":{"type":"string"}}},"schemas":{"CustomerDto":{"type":"object","properties":{"accepts_marketing":{"type":"boolean"},"active":{"type":"boolean"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressDto"}},"alternateCustomerRef":{"type":"string"},"attributeGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AttributeGroupDto"}},"averageSpendPerAnnum":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"customerRef":{"type":"string"},"customer_state":{"type":"string","enum":["disabled","invited","enabled","declined"]},"defaultAddress":{"$ref":"#/components/schemas/AddressDto"},"dob":{"type":"string","pattern":"^\\d{1,2}-\\d{1,2}-\\d{4}$"},"email":{"type":"string"},"firstName":{"type":"string","description":"first_name"},"id":{"type":"string"},"initials":{"type":"string"},"jobTitle":{"type":"string"},"joinedStoreId":{"type":"string"},"joinedStoreName":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time"},"lastName":{"type":"string","description":"last_name"},"lastOrder":{"type":"string","format":"date-time"},"lastOrderDate":{"type":"string"},"lastOrderRef":{"type":"string"},"lifetimeOrderValue":{"type":"string"},"location":{"type":"string","description":"location"},"loyaltyTier":{"type":"string"},"marketing_optin_level":{"type":"string","enum":["single_opt_in","confirmed_opt_in","unknown"]},"marketing_preferences_updated_at":{"type":"string","format":"date-time"},"memberSince":{"type":"string"},"mobile":{"type":"string"},"optin_preferences":{"$ref":"#/components/schemas/OptinPreferencesDto"},"phone":{"type":"string"},"preferredStore":{"type":"string"},"privacy":{"type":"boolean"},"running12monthSpend":{"type":"number"},"sex":{"type":"string"},"spendToNextTier":{"type":"string"},"taxExempt":{"type":"boolean","description":"tax_exempt"},"taxExemptions":{"type":"array","description":"tax_exemptions","items":{"type":"string"}},"title":{"type":"string"},"totalOrders":{"type":"string"},"totalSpend":{"type":"number"},"verified_email":{"type":"boolean"},"vipStatus":{"type":"boolean"},"work":{"type":"string"}},"title":"CustomerDto"},"AddressDto":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"addressName":{"type":"string"},"city":{"type":"string"},"company":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultAddress":{"type":"boolean","description":"default_address"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"},"provinceCode":{"type":"string"}},"title":"AddressDto"},"AttributeGroupDto":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"}},"description":{"type":"string"}},"title":"AttributeGroupDto"},"OptinPreferencesDto":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/OptinValuesDto"},"sms":{"$ref":"#/components/schemas/OptinValuesDto"}},"title":"OptinPreferencesDto"},"OptinValuesDto":{"type":"object","properties":{"opt_in_active":{"type":"boolean"},"opt_in_updated_at":{"type":"string","format":"date-time"},"opted_in_at":{"type":"string","format":"date-time"}},"title":"OptinValuesDto"}}},"paths":{"/api/v2/customers/search":{"get":{"summary":"lookupCustomer","operationId":"lookupCustomerUsingGET","parameters":[{"$ref":"#/components/parameters/email"},{"$ref":"#/components/parameters/firstName"},{"$ref":"#/components/parameters/lastName"},{"$ref":"#/components/parameters/mobile"},{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/lastItemId"},{"$ref":"#/components/parameters/X-TWC-Tenant"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomerDto"}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false,"description":"Returns a list of customers with a matching ***email***, ***mobile***, ***phone***, ***firstName***, and/or ***lastName***. \nA record is returned only if **all** of the given criteria are matched. \nIf no customers exist, this method returns a empty list.","tags":["customers"]}}}}
```