User.com REST API Docs # Find users by phone number
You can find a user based on the phone_number attribute. If you want to list all of your users with a specific phone number, add a “many=true” parameter to your request.
GET /users/search/?phone_number=_phone_number
| Attributes | Type | Required | Description |
|---|---|---|---|
| phone_number | string | yes | A user phone number. |
# 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/?phone_number=:phone_number"
# Response
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": 1,
"key": "t0K0xgs3nzML",
"name": "John Doe",
"email": "my@email.com",
"gender": "unknown",
"status": "vistor",
"phone_number": "123456789",
"first_seen": null,
"last_seen": null,
"page_views": 0,
"last_ip": null,
"timezone": null,
"city": null,
"region": null,
"country": null,
"unsubscribed": false,
"browser_language": null,
"score": 0,
"browser": null,
"os_type": null,
"resolution": null,
"created_at": "2017-09-28T14:23:59.568042Z",
"updated_at": "2017-09-28T14:23:59.895784Z",
"attributes": [],
"gravatar_url": null,
"lists": [],
"tags": [],
"notifications": true,
"facebook_url": null,
"linkedin_url": null,
"twitter_url": null,
"google_url": null,
"chat_id": "Chat ID is deprecated and will be removed in future",
"last_contacted": null,
"user_id": null
}
]
}