User.com REST API Docs # Find users by user_key
You can find a user based on the user_key attribute. The user_key is also a cookie value of __ca__chat for this user.
GET /users/search/?key=:user_key
| Attributes | Type | Required | Description |
|---|---|---|---|
| user_key | string | yes | A unique identifier (12 random characters) for the user which is given by User.com automatically. |
# 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/?key=:user_key"Copied!
# Response
{ "first_seen": null, "notifications": true, "city": null, "tags": [ { "name": "tag", "id": 1441 } ], "last_contacted": null, "page_views": 0, "status": "visitor", "chat_id": "Chat ID is deprecated and will be removed in future", "linkedin_url": null, "facebook_url": null, "gender": "unknown", "last_seen": null, "last_ip": null, "updated_at": "2017-06-07T10:29:15.955873Z", "gravatar_url": null, "id": 19678376, "os_type": null, "browser": null, "twitter_url": null, "lists": [], "created_at": "2017-06-07T09:41:13.466897Z", "name": "Jane Doe", "resolution": null, "timezone": null, "unsubscribed": false, "browser_language": null, "country": null, "google_url": null, "key": "g3FaYocCy0U6", "email": "example@email.com", "score": 0, "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 } ], "region": null, "phone_number": null }Copied!