customers/search

get/V1/customers/search

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.

Request

query Parameters

searchCriteria[currentPage]	integer Current page.
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type
searchCriteria[filterGroups][0][filters][0][field]	string Field
searchCriteria[filterGroups][0][filters][0][value]	string Value
searchCriteria[pageSize]	integer Page size.
searchCriteria[sortOrders][0][direction]	string Sorting direction.
searchCriteria[sortOrders][0][field]	string Sorting field.

Responses

200

200 Success.

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

Response samples

200
401
500
default

{"items": [{"id": 0,
"group_id": 0,
"default_billing": "string",
"default_shipping": "string",
"confirmation": "string",
"created_at": "string",
"updated_at": "string",
"created_in": "string",
"dob": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"gender": 0,
"store_id": 0,
"taxvat": "string",
"website_id": 0,
"addresses": [{"id": 0,
"customer_id": 0,
"region": {"region_code": "string",
"region": "string",
"region_id": 0,
"extension_attributes": { }
},
"region_id": 0,
"country_id": "string",
"street": ["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": true,
"default_billing": true,
"extension_attributes": { },
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
],
"disable_auto_group_change": 0,
"extension_attributes": {"company_attributes": {"customer_id": 0,
"company_id": 0,
"job_title": "string",
"status": 0,
"telephone": "string",
"extension_attributes": { }
},
"assistance_allowed": 0,
"is_subscribed": true
},
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
]
}
],
"search_criteria": {"filter_groups": [{"filters": [{"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [{"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}

➔ Next to customers/validate