GET v1.3/users
Information about users of the Conversocial app.
this resource supports additional data through the fields
parameter
Parameters
Label | Description | Values | Modifiers | Type | Required |
---|---|---|---|---|---|
fields | Return additional data about this resource e.g v1.3/users?fields=url,name,id,created |
id, first_name, last_name, timezone, date_joined, last_login, email, is_expert, crowds_name | none | query string | false |
timezone | Filter based on resources timezone e.g v1.3/users?timezone=UTC |
timezone e.g. "US/Eastern", "Europe/London". see list of tz database time zones |
none | query string | false |
date_joined | Filter based on when the user created their account e.g v1.3/users?date_joined_gte=2014-01-01&date_joined_lte=2015-01-01 |
ISO date | gt, gte, lt, lte | query string | false |
last_login | Filter based on when the userlsat logged in e.g v1.3/users?last_login_gte=2014-12-01&last_login_lte=2015-01-01 |
ISO date | gt, gte, lt, lte | query string | false |
GET v1.3/users/:id
Information about one user.
this resource supports additional data through the fields
parameter
Parameters
Label | Description | Values | Modifiers | Type | Required |
---|---|---|---|---|---|
id | The unique ID of the user resource | a user ID | none | query string | false |
Examples
Basic example
> curl -u username:password "https://api.conversocial.com/v1.3/users"
{
"paging": {
"next_page": "https://api.conversocial.com/v1.3/users?limit=10&offset=10",
"prev_page": null
},
"users": [
{
"url": "https://api.conversocial.com/v1.3/users/38228",
"id": "38228"
},
{
"url": "https://api.conversocial.com/v1.3/users/35302",
"id": "35302"
},
{
"url": "https://api.conversocial.com/v1.3/users/34942",
"id": "34942"
}
]
Example with additional fields
> curl -u username:password "https://api.conversocial.com/v1.3/users?fields=first_name,last_name,email,last_login"
{
"paging": {
"next_page": "https://api.conversocial.com/v1.3/users?limit=10&offset=10&fields=first_name%2Clast_name%2Cemail%2Clast_login",
"prev_page": null
},
"users": [
{
"first_name": "",
"last_name": "Ken-U",
"url": "https://api.conversocial.com/v1.3/users/38268",
"id": "38228",
"last_login": "2015-08-20T00:44:26",
"email": "pecheneg@14047.oauth"
},
{
"first_name": "DeAno",
"last_name": "JeAson",
"url": "https://api.conversocial.com/v1.3/users/36302",
"id": "35302",
"last_login": "2015-05-30T05:07:11",
"email": "noauth@adomain.com"
# data only available for certain accounts
"is_expert": True,
}
Example single resource
> curl -u username:password "https://api.conversocial.com/v1.3/users/36302"
{
"user": {
"first_name": "",
"last_name": "Ken-U",
"url": "https://api.conversocial.com/v1.3/users/36302",
"is_active": true,
"account": {
"url": "https://api.conversocial.com/v1.3/accounts/14047",
"id": "14047"
},
"email": "pecheneg@14047.oauth",
"last_login": "2015-08-20T00:44:26",
"timezone": "UTC",
"id": "36302",
"date_joined": "2015-08-19T02:27:51"
}
}