---
title: "customer.find"
method: GET
path: "/customer.find.json"
tags: ["customer"]
---

# customer.find

`GET /customer.find.json`

## Request

- Base URL: `https://api.api2cart.com/v1.1`
- URL: `https://api.api2cart.com/v1.1/customer.find.json`
- Auth: API key in header `x-api-key` and API key in header `x-store-key`

Find customers in store.

## Query parameters

- `find_value` string, required
- `find_where` string
- `find_params` string
- `store_id` string
- `include_guests` boolean

## Response `200`

successful operation

- ModelResponseCustomerFind
  - `return_code` integer, nullable
  - `return_message` string, nullable
  - `result` ResponseCustomerFindResult
    - `customers_count` integer, nullable
    - `customer` Customer[]
      - `id` string
      - `email` string
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `phone` string, nullable
      - `created_time` A2CDateTime
        - `value` string, nullable
        - `format` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `modified_time` A2CDateTime
        - `value` string, nullable
        - `format` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `group` CustomerGroup[]
        - `id` string
        - `name` string, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `login` string, nullable
      - `last_login` A2CDateTime
        - `value` string, nullable
        - `format` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `birth_day` A2CDateTime
        - `value` string, nullable
        - `format` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `status` string, nullable
      - `is_guest` boolean, nullable
      - `news_letter_subscription` boolean, nullable
      - `consents` CustomerConsent[]
        - `id` string
        - `type` string, nullable
        - `status` string, nullable
        - `source` string, nullable
        - `opt_in_level` string, nullable
        - `modified_time` string, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `gender` string, nullable
      - `stores_ids` string[]
      - `website` string, nullable
      - `fax` string, nullable
      - `company` string, nullable
      - `ip_address` string, nullable
      - `address_book` CustomerAddress[]
        - `id` string
        - `type` string
        - `first_name` string, nullable
        - `last_name` string, nullable
        - `postcode` string
        - `address1` string
        - `address2` string, nullable
        - `phone` string, nullable
        - `phone_mobile` string, nullable
        - `city` string
        - `country` Country
          - `code2` string
          - `code3` string
          - `name` string
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `state` State
          - `code` string
          - `name` string
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `company` string, nullable
        - `fax` string, nullable
        - `website` string, nullable
        - `gender` string, nullable
        - `region` string, nullable
        - `default` boolean
        - `tax_id` string, nullable
        - `identification_number` string, nullable
        - `alias` string, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `lang_id` string, nullable
      - `orders_count` integer, nullable
      - `last_order_id` string, nullable
      - `additional_fields` object, nullable
      - `custom_fields` object, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `additional_fields` object, nullable
  - `custom_fields` object, nullable

---

[API](https://skmtc.dev/api2cart/apis/api2cart-openapi.md) · [All operations](https://skmtc.dev/api2cart/apis/api2cart-openapi/llms.txt) · [OpenAPI document](https://skmtc.dev/api2cart/apis/api2cart-openapi/revisions/c34440741693?raw)