Response [200 Ok]

Uri	/api/v2/user/vonwong?_shorturis=
UriDescription	User By Nickname
DocUri	https://api.smugmug.com/api/v2/doc/reference/user.html
EndpointType	User
Locator	User
LocatorType	Object

User [1 of 1] - Von Wong
/api/v2/user/vonwong

Uri	/api/v2/user/vonwong
UriDescription	User By Nickname
ResponseLevel	Public
Name	Von Wong
NickName	vonwong
QuickShare	true
RefTag	L9UoKtiuH8lQQ
ViewPassHint	empty string
WebUri	https://www.vonwong.com

Uris

BioImage	/api/v2/user/vonwong!bioimage
CoverImage	/api/v2/user/vonwong!coverimage
Features	/api/v2/user/vonwong!features
Folder	/api/v2/folder/user/vonwong
Node	/api/v2/node/VtG8x
SiteSettings	/api/v2/user/vonwong!sitesettings
UrlPathLookup	/api/v2/user/vonwong!urlpathlookup
UserAlbums	/api/v2/user/vonwong!albums
UserFeaturedAlbums	/api/v2/user/vonwong!featuredalbums
UserGeoMedia	/api/v2/user/vonwong!geomedia
UserImageSearch	/api/v2/user/vonwong!imagesearch
UserPopularMedia	/api/v2/user/vonwong!popularmedia
UserProfile	/api/v2/user/vonwong!profile
UserRecentImages	/api/v2/user/vonwong!recentimages
UserTopKeywords	/api/v2/user/vonwong!topkeywords

Timing

Total

cycles	1
objects	0
time	0.03903

Request

Uri	/api/v2/user/vonwong?_shorturis=
Method	GET
Version	v2

Config

{
    "expand_method": "ref",
    "shorturis": true
}

Options

Path

Response Levels

Methods

OPTIONS

Permissions	Read

GET

Permissions	Read

Available Media Types

Output Fields

AccountStatus	select Active PastDue Suspended Closed
City	text
Country	text
Domain	text
DomainOnly	text
Email	text
FirstName	text
FriendsView	boolean
ImageCount	integer
IsAdmin	boolean
IsGettingStarted	boolean
IsTrial	boolean
IsTrialExpired	boolean
LastName	text
Name	text
NickName	text
PhoneNum	text
Plan	text
QuickShare	boolean	Toggles the display of social media icons within the sharing UI which allow the user to share a photo to a variety of social networks.
RefTag	text
SortBy	select LastUpdated Position
State	text
Street1	text
Street2	text
TotalAccountSize	text
TotalUploadedSize	text
ViewPassHint	text
ViewPassword	text
Zip	text

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/user/vonwong?_shorturis="
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "AccountStatus",
                "Type": "Select",
                "OPTIONS": [
                    "Active",
                    "PastDue",
                    "Suspended",
                    "Closed"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "FirstName",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 20
            },
            {
                "Name": "FriendsView",
                "Type": "Boolean"
            },
            {
                "Name": "ImageCount",
                "Type": "Integer",
                "MIN_VALUE": 0,
                "MAX_VALUE": 16777215
            },
            {
                "Name": "IsGettingStarted",
                "Type": "Boolean"
            },
            {
                "Name": "IsTrial",
                "Type": "Boolean"
            },
            {
                "Name": "IsTrialExpired",
                "Type": "Boolean"
            },
            {
                "Name": "LastName",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 20
            },
            {
                "Name": "NickName",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": 35
            },
            {
                "Name": "SortBy",
                "Type": "Select",
                "OPTIONS": [
                    "LastUpdated",
                    "Position"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "ViewPassHint",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "ViewPassword",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 50
            },
            {
                "Name": "Domain",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 50
            },
            {
                "Name": "DomainOnly",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 50
            },
            {
                "Name": "RefTag",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 13
            },
            {
                "Name": "Name",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Plan",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "TotalAccountSize",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "TotalUploadedSize",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "QuickShare",
                "Description": "Toggles the display of social media icons within the sharing UI which allow the user to share a photo to a variety of social networks.",
                "Type": "Boolean"
            },
            {
                "Name": "IsAdmin",
                "Type": "Boolean"
            },
            {
                "Name": "City",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 25
            },
            {
                "Name": "Country",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 20
            },
            {
                "Name": "Email",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 100
            },
            {
                "Name": "PhoneNum",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 15
            },
            {
                "Name": "State",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 20
            },
            {
                "Name": "Street1",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 40
            },
            {
                "Name": "Street2",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 40
            },
            {
                "Name": "Zip",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 10
            }
        ],
        "ResponseLevels": [
            "Full",
            "Public",
            "Password",
            "GrantAccess"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "user"
            },
            {
                "type": "singleparam",
                "param_name": "nickname",
                "param_value": "vonwong"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/user/vonwong?_shorturis=",
        "Locator": "User",
        "LocatorType": "Object",
        "User": {
            "NickName": "vonwong",
            "ViewPassHint": "",
            "RefTag": "L9UoKtiuH8lQQ",
            "Name": "Von Wong",
            "QuickShare": true,
            "Uri": "/api/v2/user/vonwong",
            "WebUri": "https://www.vonwong.com",
            "UriDescription": "User By Nickname",
            "Uris": {
                "BioImage": "/api/v2/user/vonwong!bioimage",
                "CoverImage": "/api/v2/user/vonwong!coverimage",
                "UserProfile": "/api/v2/user/vonwong!profile",
                "Node": "/api/v2/node/VtG8x",
                "Folder": "/api/v2/folder/user/vonwong",
                "Features": "/api/v2/user/vonwong!features",
                "SiteSettings": "/api/v2/user/vonwong!sitesettings",
                "UserAlbums": "/api/v2/user/vonwong!albums",
                "UserGeoMedia": "/api/v2/user/vonwong!geomedia",
                "UserPopularMedia": "/api/v2/user/vonwong!popularmedia",
                "UserFeaturedAlbums": "/api/v2/user/vonwong!featuredalbums",
                "UserRecentImages": "/api/v2/user/vonwong!recentimages",
                "UserImageSearch": "/api/v2/user/vonwong!imagesearch",
                "UserTopKeywords": "/api/v2/user/vonwong!topkeywords",
                "UrlPathLookup": "/api/v2/user/vonwong!urlpathlookup"
            },
            "ResponseLevel": "Public"
        },
        "UriDescription": "User By Nickname",
        "EndpointType": "User",
        "DocUri": "https://api.smugmug.com/api/v2/doc/reference/user.html",
        "Timing": {
            "Total": {
                "time": 0.03903,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}

OPTIONS

GET

Contents