Response [200 Ok]

Uri	/api/v2/user/scottlefler
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] - Scott Lefler
/api/v2/user/scottlefler

Uri	/api/v2/user/scottlefler
UriDescription	User By Nickname
ResponseLevel	Public
Name	Scott Lefler
NickName	scottlefler
QuickShare	true
RefTag	ehPv8IBGXXbGN
ViewPassHint	empty string
WebUri	https://scottlefler.com

Uris

BioImage
/api/v2/user/scottlefler!bioimage

Uri	/api/v2/user/scottlefler!bioimage
UriDescription	User BioImage
EndpointType	BioImage
Locator	BioImage
LocatorType	Object

CoverImage
/api/v2/user/scottlefler!coverimage

Uri	/api/v2/user/scottlefler!coverimage
UriDescription	User CoverImage
EndpointType	CoverImage
Locator	CoverImage
LocatorType	Object

Features
/api/v2/user/scottlefler!features

Uri	/api/v2/user/scottlefler!features
UriDescription	User's account features information
EndpointType	Features
Locator	Features
LocatorType	Object

Folder
/api/v2/folder/user/scottlefler

Uri	/api/v2/folder/user/scottlefler
UriDescription	A folder or legacy (sub)category by UrlPath
EndpointType	Folder
Locator	Folder
LocatorType	Object

Node
/api/v2/node/dWcn5

Uri	/api/v2/node/dWcn5
UriDescription	Node with the given id.
EndpointType	Node
Locator	Node
LocatorType	Object

SiteSettings
/api/v2/user/scottlefler!sitesettings

Uri	/api/v2/user/scottlefler!sitesettings
UriDescription	User site settings
EndpointType	SiteSettings
Locator	SiteSettings
LocatorType	Object

UrlPathLookup
/api/v2/user/scottlefler!urlpathlookup

Uri	/api/v2/user/scottlefler!urlpathlookup
UriDescription	Lookup user's folder, album, or page by path
EndpointType	UrlPathLookup
Locator	Folder,Album,Page
LocatorType	Object

UserAlbums
/api/v2/user/scottlefler!albums

Uri	/api/v2/user/scottlefler!albums
UriDescription	All of user's albums
EndpointType	UserAlbums
Locator	Album
LocatorType	Objects

UserFeaturedAlbums
/api/v2/user/scottlefler!featuredalbums

Uri	/api/v2/user/scottlefler!featuredalbums
UriDescription	User's featured albums
EndpointType	UserFeaturedAlbums
Locator	Album
LocatorType	Objects

UserGeoMedia
/api/v2/user/scottlefler!geomedia

Uri	/api/v2/user/scottlefler!geomedia
UriDescription	Geotagged images for user
EndpointType	UserGeoMedia
Locator	Image
LocatorType	Objects

UserImageSearch
/api/v2/user/scottlefler!imagesearch

Uri	/api/v2/user/scottlefler!imagesearch
UriDescription	Search for user images
EndpointType	UserImageSearch
Locator	Image
LocatorType	Objects

UserPopularMedia
/api/v2/user/scottlefler!popularmedia

Uri	/api/v2/user/scottlefler!popularmedia
UriDescription	User's popular images
EndpointType	UserPopularMedia
Locator	Image
LocatorType	Objects

UserProfile
/api/v2/user/scottlefler!profile

Uri	/api/v2/user/scottlefler!profile
UriDescription	User's profile information
EndpointType	UserProfile
Locator	UserProfile
LocatorType	Object

UserRecentImages
/api/v2/user/scottlefler!recentimages

Uri	/api/v2/user/scottlefler!recentimages
UriDescription	User's recent images
EndpointType	UserRecentImages
Locator	Image
LocatorType	Objects

UserTopKeywords
/api/v2/user/scottlefler!topkeywords

Uri	/api/v2/user/scottlefler!topkeywords
UriDescription	User's top keywords
EndpointType	UserTopKeywords
Locator	UserTopKeywords
LocatorType	Object

Timing

Total

cycles	1
objects	0
time	0.02007

Request

Uri	/api/v2/user/scottlefler
Method	GET
Version	v2

Config

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

Options

Path

Response Levels

Methods

OPTIONS

Permissions	Read

GET

Permissions	Read

Available Media Types

Output Fields

AccountStatus	select Active PastDue Suspended Closed
Domain	text
DomainOnly	text
FirstName	text
FriendsView	boolean
ImageCount	integer
IsTrial	boolean
LastName	text
Name	text
NickName	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
TotalAccountSize	text
TotalUploadedSize	text
ViewPassHint	text
ViewPassword	text

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/user/scottlefler"
    },
    "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": "IsTrial",
                "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"
            }
        ],
        "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": "scottlefler"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/user/scottlefler",
        "Locator": "User",
        "LocatorType": "Object",
        "User": {
            "NickName": "scottlefler",
            "ViewPassHint": "",
            "RefTag": "ehPv8IBGXXbGN",
            "Name": "Scott Lefler",
            "QuickShare": true,
            "Uri": "/api/v2/user/scottlefler",
            "WebUri": "https://scottlefler.com",
            "UriDescription": "User By Nickname",
            "Uris": {
                "BioImage": {
                    "Uri": "/api/v2/user/scottlefler!bioimage",
                    "Locator": "BioImage",
                    "LocatorType": "Object",
                    "UriDescription": "User BioImage",
                    "EndpointType": "BioImage"
                },
                "CoverImage": {
                    "Uri": "/api/v2/user/scottlefler!coverimage",
                    "Locator": "CoverImage",
                    "LocatorType": "Object",
                    "UriDescription": "User CoverImage",
                    "EndpointType": "CoverImage"
                },
                "UserProfile": {
                    "Uri": "/api/v2/user/scottlefler!profile",
                    "Locator": "UserProfile",
                    "LocatorType": "Object",
                    "UriDescription": "User's profile information",
                    "EndpointType": "UserProfile"
                },
                "Node": {
                    "Uri": "/api/v2/node/dWcn5",
                    "Locator": "Node",
                    "LocatorType": "Object",
                    "UriDescription": "Node with the given id.",
                    "EndpointType": "Node"
                },
                "Folder": {
                    "Uri": "/api/v2/folder/user/scottlefler",
                    "Locator": "Folder",
                    "LocatorType": "Object",
                    "UriDescription": "A folder or legacy (sub)category by UrlPath",
                    "EndpointType": "Folder"
                },
                "Features": {
                    "Uri": "/api/v2/user/scottlefler!features",
                    "Locator": "Features",
                    "LocatorType": "Object",
                    "UriDescription": "User's account features information",
                    "EndpointType": "Features"
                },
                "SiteSettings": {
                    "Uri": "/api/v2/user/scottlefler!sitesettings",
                    "Locator": "SiteSettings",
                    "LocatorType": "Object",
                    "UriDescription": "User site settings",
                    "EndpointType": "SiteSettings"
                },
                "UserAlbums": {
                    "Uri": "/api/v2/user/scottlefler!albums",
                    "Locator": "Album",
                    "LocatorType": "Objects",
                    "UriDescription": "All of user's albums",
                    "EndpointType": "UserAlbums"
                },
                "UserGeoMedia": {
                    "Uri": "/api/v2/user/scottlefler!geomedia",
                    "Locator": "Image",
                    "LocatorType": "Objects",
                    "UriDescription": "Geotagged images for user",
                    "EndpointType": "UserGeoMedia"
                },
                "UserPopularMedia": {
                    "Uri": "/api/v2/user/scottlefler!popularmedia",
                    "Locator": "Image",
                    "LocatorType": "Objects",
                    "UriDescription": "User's popular images",
                    "EndpointType": "UserPopularMedia"
                },
                "UserFeaturedAlbums": {
                    "Uri": "/api/v2/user/scottlefler!featuredalbums",
                    "Locator": "Album",
                    "LocatorType": "Objects",
                    "UriDescription": "User's featured albums",
                    "EndpointType": "UserFeaturedAlbums"
                },
                "UserRecentImages": {
                    "Uri": "/api/v2/user/scottlefler!recentimages",
                    "Locator": "Image",
                    "LocatorType": "Objects",
                    "UriDescription": "User's recent images",
                    "EndpointType": "UserRecentImages"
                },
                "UserImageSearch": {
                    "Uri": "/api/v2/user/scottlefler!imagesearch",
                    "Locator": "Image",
                    "LocatorType": "Objects",
                    "UriDescription": "Search for user images",
                    "EndpointType": "UserImageSearch"
                },
                "UserTopKeywords": {
                    "Uri": "/api/v2/user/scottlefler!topkeywords",
                    "Locator": "UserTopKeywords",
                    "LocatorType": "Object",
                    "UriDescription": "User's top keywords",
                    "EndpointType": "UserTopKeywords"
                },
                "UrlPathLookup": {
                    "Uri": "/api/v2/user/scottlefler!urlpathlookup",
                    "Locator": "Folder,Album,Page",
                    "LocatorType": "Object",
                    "UriDescription": "Lookup user's folder, album, or page by path",
                    "EndpointType": "UrlPathLookup"
                }
            },
            "ResponseLevel": "Public"
        },
        "UriDescription": "User By Nickname",
        "EndpointType": "User",
        "DocUri": "https://api.smugmug.com/api/v2/doc/reference/user.html",
        "Timing": {
            "Total": {
                "time": 0.02007,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}

OPTIONS

GET

Contents