User.com REST API Docs # Find users by email
You can find a user based on an email attribute. If you want to list all of your users with a specific email, add a “many=true” parameter to your request.
GET /users/search/?email=:email
| Attributes | Type | Required | Description |
|---|---|---|---|
| string | yes | A user email address. |
| Lookup | Description | Example usage |
|---|---|---|
| contains | Case-sensitive containment test. | ?email__contains=@user.com |
# Request
- CURL
- JavaScript
- PHP
- Python
curl -X GET -H "Authorization: Token <your_64_char_api_key>"
-H "Accept: */*; version=2"
"https://<your_app_subdomain>.user.com/api/public/users/search/?email=:email"
# Response
{
"facebook_url": null,
"region": null,
"notifications": true,
"last_ip": null,
"attributes": [
{
"value": true,
"name": "Example attr",
"name_std": "example_attr",
"id": 1109
},
{
"value": "attribute value",
"name": "My string attr",
"name_std": "my_string_attr",
"id": 2429
}
],
"country": null,
"resolution": null,
"name": "Jane Doe",
"browser_language": null,
"email": "example@email.com",
"os_type": null,
"created_at": "2017-06-07T09:41:13.466897Z",
"unsubscribed": false,
"timezone": null,
"gravatar_url": null,
"chat_id": "Chat ID is deprecated and will be removed in future",
"browser": null,
"key": "g3FaYocCy0U6",
"id": 19678376,
"updated_at": "2017-06-07T10:29:15.955873Z",
"score": 0,
"google_url": null,
"city": null,
"first_seen": null,
"status": "visitor",
"tags": [
{
"name": "tag",
"id": 1441
}
],
"gender": "unknown",
"linkedin_url": null,
"twitter_url": null,
"last_contacted": null,
"phone_number": null,
"lists": [],
"last_seen": null,
"page_views": 0
}
{
"facebook_url": null,
"region": null,
"notifications": true,
"last_ip": null,
"attributes": [
{
"value": true,
"name": "Example attr",
"name_std": "example_attr",
"id": 1100
},
{
"value": "attribute value",
"name": "My string attr",
"name_std": "my_string_attr",
"id": 2400
}
],
"country": null,
"resolution": null,
"name": "Christian Dior",
"browser_language": null,
"email": "example@email.com",
"os_type": null,
"created_at": "2017-06-07T09:41:13.466897Z",
"unsubscribed": false,
"timezone": null,
"gravatar_url": null,
"chat_id": "Chat ID is deprecated and will be removed in future",
"browser": null,
"key": "g3FaYocCy0U6",
"id": 1949376,
"updated_at": "2017-06-07T10:29:15.955873Z",
"score": 0,
"google_url": null,
"city": null,
"first_seen": null,
"status": "visitor",
"tags": [
{
"name": "tag2",
"id": 1440
}
],
"gender": "unknown",
"linkedin_url": null,
"twitter_url": null,
"last_contacted": null,
"phone_number": null,
"lists": [],
"last_seen": null,
"page_views": 0
}