- 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 \ List all users
Send a GET request to this resource to obtain the list of your users.
| 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.<format> to obtain the list of your users.
2. Result: the code returned by the API
The API will return the list of your users. Each user entry contains a <user_token>
that uniquely identifies the user. You can use the <user_token> to obtain more details
about the user.
Example for a list containing two users:
{
"response": {
"request": {
"date": "Tue, 13 Sep 2011 10:31:46 0200",
"resource": "/users.json",
"status": {
"flag": "success",
"code": 200
}
},
"result": {
"data": {
"users": {
"count": 2,
"entries": [
{
"user_token": "247db8ab-0af5-4a01-8dd1-a9454d76c23e",
"date_creation": "Wed, 14 Jan 2011 12:13:00 0200",
"date_last_login": "Wed, 24 Aug 2011 17:23:00 0200",
"num_logins": 148
},
{
"user_token": "2b1c1cbe-8af2-420b-a22d-acb3b752496b",
"date_creation": "Tue, 02 Mar 2011 23:19:47 0200",
"date_last_login": "Tue, 02 Aug 2011 13:14:47 0200",
"num_logins": 5
}
]
}
}
}
}
}
Example for a list without any users:
{
"response": {
"request": {
"date": "Tue, 10 Sep 2011 10:21:46 0200",
"resource": "/users.json",
"status": {
"flag": "success",
"code": 200
}
},
"result": {
"data": {
"users": {
"count": 0
}
}
}
}
}