Users

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

email REQUIRED
The user’s email address


Response

active (true|false) whether or not the user is active
currency The user’s preferred currency. Also the currency all monetary reports will be reported in. Currencies can be found here.
region (us|gb) The user’s preferred region for date and time format.
is_owner (true | false) True if this user created the account, false otherwise.
share_of_profit The user’s share of the profit, represented as a float between 0.01 and 1.00
last_login Date of the user’s last login to the site
timezone The user’s preferred timezone. Also the timezone ranks reports will be reported in.
account An object representing the user’s account. See table below for details.
id The user’s Appfigures ID
role 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 The user’s full name
email The user’s email address.
products 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 A format to match the user’s region.
Account
id The account’s Appfigures ID
name Account’s name
company Account’s company name
auto_import (true | false) whether or not the account supports autoimport
last_import The time of the last successful import of any of the account’s external accounts
plan 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
        }
    ]
}
  • samuelcuster

    Are there any plans for deleting users via the API?

    • Yes, right now user management is available on the Enterprise plan. Contact us directly if you’re interested in learning more about that.

  • Is there any plans for creating users via the API?

    • appfigures

      Not in the immediate future but if that’s something you need please contact us through the site and tell us about your use case.