---
title: "Retrieve a Customer List from a query."
method: GET
path: "/customers/search.json"
tags: ["Customers"]
---

# Retrieve a Customer List from a query.

`GET /customers/search.json`

Endpoint example: 

```text
https://api.jumpseller.com/v1/customers/search.json?query=test&order=desc,description 
```

## Query parameters

- `query` string, string, required
- `order` string, string
- `limit` integer
- `page` integer

## Response `200`

An array of Customers

- Customer[]
  - `customer` CustomerFields
    - `id` integer — Unique identifier of the Customer
    - `email` string — Email of the Customer
    - `phone` string — Phone of the Customer
    - `fullname` string — Customer fullname retrieved from the default billing address. Defaults to customer email if no name is found.
    - `status` 'approved' | 'pending' | 'disabled' — Status of the Customer
    - `accepts_marketing` boolean — Indicates whether the Customer accepts marketing or not
    - `accepted_marketing_at` string — Marketing acceptation start date. Should be in format 'Y-m-d
    - `cancelled_marketing_at` string — Marketing cancelation start date. Should be in format 'Y-m-d
    - `shipping_address` ShippingAddress
      - `name` string — Name of the Customer's Shipping Address
      - `surname` string — Surname of the Customer's Shipping Address
      - `address` string — Address of the Customer's Shipping Address
      - `city` string — City of the Customer's Shipping Address
      - `postal` string — Postal code of the Customer's Shipping Address
      - `municipality` string — Municipality of the Customer's Shipping Address
      - `neighbourhood` string — Third level of administrative subdivision of the Customer's Shipping Address used only for some countries (e.g. Mexico)
      - `region` string — Region code of the Customer's Shipping Address (Use the FIPS standard - http://www.geonames.org/countries/)
      - `country` string — Country code of the Customer's Shipping Address (ISO 3166-1 alpha-2)
    - `billing_address` BillingAddress
      - `name` string — Name of the Customer's Billing Address
      - `surname` string — Surname of the Customer's Billing Address
      - `taxid` string — Tax id of the Customer's Billing Address
      - `address` string — Address of the Customer's Billing Address
      - `city` string — City of the Customer's Billing Address
      - `postal` string — Postal code of the Customer's Billing Address
      - `municipality` string — Municipality of the Customer's Billing Address
      - `neighbourhood` string — Third level of administrative subdivision of the Customer's Billing Address used only for some countries (e.g. Mexico)
      - `region` string — Region code of the Customer's Billing Address (Use the FIPS standard - http://www.geonames.org/countries/)
      - `country` string — Country code of the Customer's Billing Address (ISO 3166-1 alpha-2)
    - `customer_categories` CustomerCategory[]
      - `customer_category` CustomerCategoryFields
        - `id` integer — Unique identifier of the CustomerCategory
        - `name` string — Name of the CustomerCategory
        - `code` string — Code of the CustomerCategory
    - `customer_additional_fields` CustomerAdditionalField[]
      - `customer_additional_field` CustomerAdditionalFieldFields
        - `id` integer — Unique identifier of the Customer Additional Field
        - `label` string — Label of the Customer Additional Field
        - `value` string — Value of the Customer Additional Field
        - `area` string — Area of the Customer Additional Field
        - `customer_id` integer — Unique identifier of the Customer
        - `checkout_custom_field_id` integer — Unique identifier of the Checkout Custom Field

---

[API](https://skmtc.net/jumpseller/apis/jumpseller-api.md) · [All operations](https://skmtc.net/jumpseller/apis/jumpseller-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jumpseller/jumpseller-api/versions/7512c6ae3524/schema)