Search

customer Customer Repository V1Get List Get

get

Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

Query parameters

searchCriteria[filterGroups][0][filters][0][field]stringOptional

Field

Example: <string>

searchCriteria[filterGroups][0][filters][0][value]stringOptional

Value

Example: <string>

searchCriteria[filterGroups][0][filters][0][conditionType]stringOptional

Condition type

Example: <string>

searchCriteria[sortOrders][0][field]stringOptional

Sorting field.

Example: <string>

searchCriteria[sortOrders][0][direction]stringOptional

Sorting direction.

Example: <string>

searchCriteria[pageSize]stringOptional

Page size.

Example: <integer>

searchCriteria[currentPage]stringOptional

Current page.

Example: <integer>

Responses

200

OK

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /V1/customers/search HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "items": [
    {
      "email": "<string>",
      "firstname": "<string>",
      "lastname": "<string>",
      "id": "<integer>",
      "group_id": "<integer>",
      "default_billing": "<string>",
      "default_shipping": "<string>",
      "confirmation": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "created_in": "<string>",
      "dob": "<string>",
      "middlename": "<string>",
      "prefix": "<string>",
      "suffix": "<string>",
      "gender": "<integer>",
      "store_id": "<integer>",
      "taxvat": "<string>",
      "website_id": "<integer>",
      "addresses": [
        {
          "id": "<integer>",
          "customer_id": "<integer>",
          "region": {
            "region_code": "<string>",
            "region": "<string>",
            "region_id": "<integer>",
            "extension_attributes": "<object>"
          },
          "region_id": "<integer>",
          "country_id": "<string>",
          "street": [
            "<string>",
            "<string>"
          ],
          "company": "<string>",
          "telephone": "<string>",
          "fax": "<string>",
          "postcode": "<string>",
          "city": "<string>",
          "firstname": "<string>",
          "lastname": "<string>",
          "middlename": "<string>",
          "prefix": "<string>",
          "suffix": "<string>",
          "vat_id": "<string>",
          "default_shipping": "<boolean>",
          "default_billing": "<boolean>",
          "extension_attributes": "<object>",
          "custom_attributes": [
            {
              "attribute_code": "aliquip quis ut anim",
              "value": "irure labore laboris dolor"
            },
            {
              "attribute_code": "sit cillum dolore cupidatat",
              "value": "dolore aliquip do officia qui"
            }
          ]
        },
        {
          "id": "<integer>",
          "customer_id": "<integer>",
          "region": {
            "region_code": "<string>",
            "region": "<string>",
            "region_id": "<integer>",
            "extension_attributes": "<object>"
          },
          "region_id": "<integer>",
          "country_id": "<string>",
          "street": [
            "<string>",
            "<string>"
          ],
          "company": "<string>",
          "telephone": "<string>",
          "fax": "<string>",
          "postcode": "<string>",
          "city": "<string>",
          "firstname": "<string>",
          "lastname": "<string>",
          "middlename": "<string>",
          "prefix": "<string>",
          "suffix": "<string>",
          "vat_id": "<string>",
          "default_shipping": "<boolean>",
          "default_billing": "<boolean>",
          "extension_attributes": "<object>",
          "custom_attributes": [
            {
              "attribute_code": "deserunt dolor",
              "value": "vol"
            },
            {
              "attribute_code": "deserunt",
              "value": "incididunt non mollit"
            }
          ]
        }
      ],
      "disable_auto_group_change": "<integer>",
      "extension_attributes": {
        "assistance_allowed": "<integer>",
        "is_subscribed": "<boolean>",
        "amazon_id": "<string>",
        "vertex_customer_code": "<string>",
        "vertex_customer_country": "<string>"
      },
      "custom_attributes": [
        {
          "attribute_code": "veniam do commodo anim voluptate",
          "value": "eu Duis officia nulla ad"
        },
        {
          "attribute_code": "et id non nostrud aute",
          "value": "Excepteu"
        }
      ]
    },
    {
      "email": "<string>",
      "firstname": "<string>",
      "lastname": "<string>",
      "id": "<integer>",
      "group_id": "<integer>",
      "default_billing": "<string>",
      "default_shipping": "<string>",
      "confirmation": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "created_in": "<string>",
      "dob": "<string>",
      "middlename": "<string>",
      "prefix": "<string>",
      "suffix": "<string>",
      "gender": "<integer>",
      "store_id": "<integer>",
      "taxvat": "<string>",
      "website_id": "<integer>",
      "addresses": [
        {
          "id": "<integer>",
          "customer_id": "<integer>",
          "region": {
            "region_code": "<string>",
            "region": "<string>",
            "region_id": "<integer>",
            "extension_attributes": "<object>"
          },
          "region_id": "<integer>",
          "country_id": "<string>",
          "street": [
            "<string>",
            "<string>"
          ],
          "company": "<string>",
          "telephone": "<string>",
          "fax": "<string>",
          "postcode": "<string>",
          "city": "<string>",
          "firstname": "<string>",
          "lastname": "<string>",
          "middlename": "<string>",
          "prefix": "<string>",
          "suffix": "<string>",
          "vat_id": "<string>",
          "default_shipping": "<boolean>",
          "default_billing": "<boolean>",
          "extension_attributes": "<object>",
          "custom_attributes": [
            {
              "attribute_code": "et exercitation",
              "value": "sunt co"
            },
            {
              "attribute_code": "anim enim ut minim",
              "value": "nostrud ut"
            }
          ]
        },
        {
          "id": "<integer>",
          "customer_id": "<integer>",
          "region": {
            "region_code": "<string>",
            "region": "<string>",
            "region_id": "<integer>",
            "extension_attributes": "<object>"
          },
          "region_id": "<integer>",
          "country_id": "<string>",
          "street": [
            "<string>",
            "<string>"
          ],
          "company": "<string>",
          "telephone": "<string>",
          "fax": "<string>",
          "postcode": "<string>",
          "city": "<string>",
          "firstname": "<string>",
          "lastname": "<string>",
          "middlename": "<string>",
          "prefix": "<string>",
          "suffix": "<string>",
          "vat_id": "<string>",
          "default_shipping": "<boolean>",
          "default_billing": "<boolean>",
          "extension_attributes": "<object>",
          "custom_attributes": [
            {
              "attribute_code": "cillum reprehenderit occaecat Lorem",
              "value": "minim magna in exercitation"
            },
            {
              "attribute_code": "in reprehenderit",
              "value": "ad culpa adipisicing est"
            }
          ]
        }
      ],
      "disable_auto_group_change": "<integer>",
      "extension_attributes": {
        "assistance_allowed": "<integer>",
        "is_subscribed": "<boolean>",
        "amazon_id": "<string>",
        "vertex_customer_code": "<string>",
        "vertex_customer_country": "<string>"
      },
      "custom_attributes": [
        {
          "attribute_code": "Ut anim dolor et",
          "value": "amet sint"
        },
        {
          "attribute_code": "deserunt",
          "value": "nisi"
        }
      ]
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "dolor Lorem commodo officia reprehenderit",
            "value": "pariatur tempor laborum cillum mollit",
            "condition_type": "sint esse est dolore"
          },
          {
            "field": "est occaecat",
            "value": "non irure est dolore laborum",
            "condition_type": "velit cillum Excepteur labore magna"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "proident dolore",
            "value": "reprehenderit",
            "condition_type": "eu adipisicing dolor irure dolore"
          },
          {
            "field": "et laborum mollit velit",
            "value": "eu",
            "condition_type": "proident"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "minim aliquip ad",
        "direction": "deserunt amet non cillum"
      },
      {
        "field": "occaecat al",
        "direction": "aliquip eiusmod"
      }
    ],
    "page_size": 24025874,
    "current_page": -27062673
  },
  "total_count": 21768198
}