Home
Documentation
Resources
Certifications
Community
Search customers - Customers - Mercado Pago Developers

Intelligent search powered by OpenAI 

Search customers

GET

https://api.mercadopago.com/v1/customers/search
Find all customer information using specific filters.
Request's parameters
QUERY
email
string

REQUIRED

Customer's email.
Response parameters
paging
object
Information for pagination of search results.
results
array
The page of items. This will be an empty array if there are no results.
Errors

400Error

100

the credentials are required.

101

the customer already exist.

102

missing customer id.

103

parameter must be an object

104

parameter length is too large.

105

the customer id is invalid.

106

the email format is invalid.

107

the first_name is invalid.

108

the last_name is invalid.

109

the phone.area_code is invalid.

110

the phone.number is invalid.

111

the identification.type is invalid.

112

the identification.number is invalid.

113

the address.zip_code is invalid.

114

the address.street_name is invalid.

115

the date_registered format is invalid.

116

the description is invalid.

117

the metadata is invalid.

118

the body must be a Json Object.

119

the card is required.

120

card not found.

121

the card is invalid.

122

the card data is invalid.

123

the payment_method_id is required.

124

the issuer_id is required.

125

invalid parameters.

126

invalid parameter. You cannot update the email.

127

invalid parameter. Cannot resolve the payment method of card, check the payment_method_id and issuer_id.

128

the email format is invalid. Use 'test_payer_[0-9]{1,10}@testuser.com'.

129

the customer has reached the maximum allowed number of cards.

140

invalid card owner.

150

invalid users involved.

200

invalid range format (range=:date_parameter:after::date_from,before::date_to).

201

range attribute must belong to date entity.

202

invalid 'after' parameter. It should be date[iso_8601].

203

invalid 'before' parameter. It should be date[iso_8601].

204

invalid filters format.

205

invalid query format.

206

attributes to sort must belong to 'customer' entity.

207

order filter must be 'asc' or 'desc'.

208

invalid 'sort' parameter format.

214

invalid zip code.

401Error

unauthorized

unauthorized.

404Error

not_found

not_found.

Request
curl -X GET \
    'https://api.mercadopago.com/v1/customers/search?email=jhon@doe.com'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
    
Sample answer
{
  "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"
      }
    }
  ]
}