GET login/users
(Difference between revisions)
Renato.neves (Talk | contribs) (→Examples) |
Renato.neves (Talk | contribs) |
||
| Line 1: | Line 1: | ||
== Description == | == Description == | ||
| − | Returns all users or searches for login app users given some attributes such as mac_address, username and e-mail address | + | Returns all users or searches for login app users given some attributes such as mac_address, username and e-mail address. |
| + | |||
| + | <span style="color: green">Not available in production yet</span> | ||
== Resource URL == | == Resource URL == | ||
| − | GET https://api.socialidnow.com/v1/marketing/login/users | + | GET https://api.socialidnow.com/v1/marketing/login/users |
== Parameters == | == Parameters == | ||
Revision as of 12:42, 17 November 2015
Contents |
Description
Returns all users or searches for login app users given some attributes such as mac_address, username and e-mail address.
Not available in production yet
Resource URL
GET https://api.socialidnow.com/v1/marketing/login/users
Parameters
URL Parameters
| mac_address | optional | user mac_address. |
|---|---|---|
| username | optional | username. |
| email_address | optional | user e-mail address. |
| page | optional | page number (each page contains page_size results). Default: 1. |
| page_size | optional | maximum amount of results to be returned. Default: 100. |
| fields | optional | a list of user profile field names to be returned, joined by commas. See Social Profile Fields. |
Authentication
This API requires Social Login App authentication. See Authentication.
Response
Response Status
| ok (200) | The request was successfully. |
|---|---|
| unauthorized (401) | The authentication is wrong. See Authentication. |
| internal_server_error (500) | An unknown error happened. |
Response Body
A successful search returns the following fields:
| count | amount of posts returned in the page (according to the specified page_size). |
|---|---|
| results | array with user details. See response from GET login/users/:user_id |
Examples
Using mac_address
Request
curl -iX GET 'https://api.socialidnow.com/v1/marketing/login/users?mac_address=6C:A1:18:AD:32:92' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{
"count": 1,
"results": [
{
"id": 341,
"signed_in_at": "2014-10-24T08:13:51Z",
"signed_up_at": "2014-10-23T16:47:15Z",
"token": "f83f40b5658970893f2dc8e9dcbe01527573fb304c441c21513ef0be29a25990",
"username": "john_doe",
"email_address": "john_doe@domain.com",
"active": "true",
"confirmed": "true"
}
]
}
Using username
Request
curl -iX GET 'https://api.socialidnow.com/v1/marketing/login/users?username=john_doe' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{
"count": 1,
"results": [
{
"id": 341,
"signed_in_at": "2014-10-24T08:13:51Z",
"signed_up_at": "2014-10-23T16:47:15Z",
"token": "f83f40b5658970893f2dc8e9dcbe01527573fb304c441c21513ef0be29a25990",
"username": "john_doe",
"email_address": "john_doe@domain.com",
"active": "true",
"confirmed": "true"
}
]
}
Using email_address
Request
curl -iX GET 'https://api.socialidnow.com/v1/marketing/login/users?email_address=john_doe@domain.com' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{
"count": 1,
"results": [
{
"id": 341,
"signed_in_at": "2014-10-24T08:13:51Z",
"signed_up_at": "2014-10-23T16:47:15Z",
"token": "f83f40b5658970893f2dc8e9dcbe01527573fb304c441c21513ef0be29a25990",
"username": "john_doe",
"email_address": "john_doe@domain.com",
"active": "true",
"confirmed": "true"
}
]
}
