The /users
resource allows access to user settings for the current user (used to authenticate), as well as sub-users, provided the user used to authenticate has the Admin role.
Getting details for a user
Request
GET /users/{email}
Scope: This resource requires the account:read scope.
Arguments
Argument |
Type |
Description |
email |
String |
The email address of the user to look up. Must be a member of your account. |
Response
Field |
Type |
Description |
active |
Bool |
(true|false) whether or not the user is active |
currency |
String |
The user’s preferred currency. Also the currency all monetary reports will be reported in. Currencies can be found here. |
region |
String |
(us|gb) The user’s preferred region for date and time format. |
is_owner |
Bool |
(true | false) True if this user created the account, false otherwise. |
last_login |
Date |
Date of the user’s last login to the site |
timezone |
String |
The user’s preferred timezone. Also the timezone ranks reports will be reported in. |
account |
Account |
An object representing the user’s account. See table below for details. |
id |
Number |
The user’s Appfigures ID |
role |
String |
The permission level of this user. Possible values are: viewer, admin. Some resources cannot be accessed by viewer users. Requests to those resources will result in a 403 Forbidden error. |
name |
String |
The user’s full name |
email |
String |
The user’s email address. |
products |
List |
An array of products that this user has access to. Scroll down to the next method for more details about the product object. |
date_format |
String |
A format to match the user’s region. |
Account
Field |
Type |
Description |
id |
String |
The account’s Appfigures ID |
name |
String |
Account’s name |
company |
String |
Account’s company name |
auto_import |
String |
(true | false) whether or not the account supports autoimport |
last_import |
String |
The time of the last successful import of any of the account’s external accounts |
plan |
String |
The account’s plan: free, premium, publisher. Some resources cannot be accessed by users who are on the free plan. These resources will result in a 403 Forbidden error. |
Example Response
// GET /users/john@fobsdirect.com
{
"active": true,
"currency": "EUR",
"region": "US",
"is_owner": false,
"share_of_profit": "1.00",
"last_login": "2017-06-02T13:02:47",
"timezone": "GMT Standard Time",
"account": {
"id": 42,
"name": "john",
"company": "Fobs Direct",
"auto_import": "N/A",
"last_import": "2017-06-02T07:22:26",
"plan": "premium"
},
"id": 142,
"role": "admin",
"name": "John Q",
"email": "john@fobsdirect.com",
"date_format": "MM/dd/yy",
"products": [
{
"id": 2345,
"name": "Fob Finder Free",
"developer": "Fobs Direct Inc",
"icon": "http://a4.mzstatic.com/us/r1000/030/Purple/75/f4/1a/mzl.krtyudsu.100x100-75.jpg",
"vendor_identifier": "000000000",
"ref_no": 00000000,
"sku": null,
"store_id": 1,
"store": "apple",
"release_date": "2011-11-15T05:00:00",
"added_date": "2011-11-15T19:06:11",
"updated_date": "2017-06-12T09:02:44",
"version": "1.2",
"source": {
"external_account_id": 1,
"added_timestamp": "2011-01-02T17:50:00",
"active": true,
"hidden": false,
"type": "own"
},
"type": "app",
"devices": [
"Handheld",
"Tablet"
],
"children": [],
"features": [],
"parent_id": null
}
]
}