Search customers/v1/customers/searchFind all customer information using specific filters.
GET
Products that use it:
Request's parameters
emailstring
Localization: queryCustomer's email.REQUIRED
Response parameters
paging
Localization: bodyInformation for pagination of search results.object
results
Localization: bodyThe page of items. This will be an empty array if there are no results.array
Request
curl
curl -X GET \
'https://api.mercadopago.com/v1/customers/search?email=jhon@doe.com' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' Answer
json
{
"paging": {
"limit": 10,
"offset": 0,
"total": 1
},
"results": [
{
"address": {
"id": "1162600213",
"street_name": "Caetano Poli, 12",
"zip_code": "05187010"
},
"addresses": [
{}
],
"cards": [
{}
],
"date_created": "2017-05-05T04:00:00.000Z",
"date_last_updated": "2017-05-05T13:23:25.021Z",
"default_address": "1162600213",
"default_card": 1493990563105,
"email": "test@test.com",
"first_name": "Customer",
"id": "123456789-jxOV430go9fx2e",
"identification": {
"number": "19119119100",
"type": "CPF"
},
"last_name": "Tester",
"live_mode": true,
"metadata": {},
"phone": {
"area_code": "11",
"number": "987654321"
}
}
]
}Errors
400bad_request
100
101the customer already exist.
102missing customer id.
103parameter must be an object
104parameter length is too large.
105the customer id is invalid.
106the email format is invalid.
107the first_name is invalid.
108the last_name is invalid.
109the phone.area_code is invalid.
110the phone.number is invalid.
111the identification.type is invalid.
112the identification.number is invalid.
113the address.zip_code is invalid.
114the address.street_name is invalid.
115the date_registered format is invalid.
116the description is invalid.
117the metadata is invalid.
118the body must be a Json Object.
119the card is required.
120card not found.
121the card is invalid.
122the card data is invalid.
123the payment_method_id is required.
124the issuer_id is required.
125invalid parameters.
126invalid parameter. You cannot update the email.
127invalid parameter. Cannot resolve the payment method of card, check the payment_method_id and issuer_id.
128the email format is invalid. Use 'test_payer_[0-9]{1,10}@testuser.com'.
129the customer has reached the maximum allowed number of cards.
140invalid card owner.
150invalid users involved.
200invalid range format (range=:date_parameter:after::date_from,before::date_to).
201range attribute must belong to date entity.
202invalid 'after' parameter. It should be date[iso_8601].
203invalid 'before' parameter. It should be date[iso_8601].
204invalid filters format.
205invalid query format.
206attributes to sort must belong to 'customer' entity.
207order filter must be 'asc' or 'desc'.
208invalid 'sort' parameter format.
401bad_request
unauthorizedunauthorized.
404bad_request
not_foundnot_found.