- Basic Information Terminology, getting started and setting up your account. Recommended for new customers.
- Make your website social Step-by-step tutorials and information on how to integrate our plugins and services to your site.
- REST API Reference JSON/REST API for advanced social network integration. Must-read for developers.
User API \ Read a user's details
Send a GET request to this resource to retrieve the details of an existing user.
| Resource/URI | GET | POST | PUT | DELETE |
Users
/users.<format>
|
List all users | – | – | – |
User
/users/<user_token>.<format>
|
Retrieve a user's details | – | – | Delete a user |
User
/users/<user_token>/contacts.<format>
|
Read a user's contacts | – | – | – |
User
/users/<user_token>/publish.<format>
|
– | Publish on social networks | – | – |
Workflow
1. Request: the code to send to the API
Send a GET request to the resource /users/<user_token>.<format> to obtain the details of an existing user.
The <user_token> has to be replaced by the unique token of an existing user.
2. Result: the code returned by the API
The API will return the details of the corresponding user. The social identities (wrapped social network profiles) of the users are always returned in the Portable Contacts Format. Depending on the social network, more or less information is available.
{
"response": {
"request": {
"date": "Tue, 13 Sep 2011 11:24:28 +0200",
"resource": "/users/2cec711d-ca14-4472-98c8-ca74432bc2d3.json",
"status": {
"flag": "success",
"code": 200
}
},
"result":{
"data":{
"user":{
"user_token": "2cec711d-ca14-4472-98c8-ca74432bc2d3",
"date_creation": "Tue, 1 Sep 2011 11:01:12 +0200",
"date_last_login": "Tue, 13 Sep 2011 01:05:07 +0200",
"num_logins": "64",
"identities": {
"identity": [
{
"identity_token": "cd3bd13b-b393-4d6c-a7f6-950b4c47938f",
"provider": "yahoo",
"id": "http://twitter.com/ExampleUser",
"displayName": "Firstname Lastname",
"name":{
"formatted": "Firstname Lastname"
},
"gender": "male",
"utcOffset": "2:00",
"emails":[
{
"value": "email@example.com",
"type": "other"
}
]
}
]
}
}
}
}
}
}