SmugMug API - User By Nickname

Response [200 Ok]

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

Timing

Total

cycles 1
objects 0
time 0.01602

Options

Path

  • /api
  • /v2
  • /user
  • /

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

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?_shorturis=u0026_verbosity=3"
    },
    "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?_shorturis=u0026_verbosity=3",
        "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": "/api/v2/user/scottlefler!bioimage",
                "CoverImage": "/api/v2/user/scottlefler!coverimage",
                "UserProfile": "/api/v2/user/scottlefler!profile",
                "Node": "/api/v2/node/dWcn5",
                "Folder": "/api/v2/folder/user/scottlefler",
                "Features": "/api/v2/user/scottlefler!features",
                "SiteSettings": "/api/v2/user/scottlefler!sitesettings",
                "UserAlbums": "/api/v2/user/scottlefler!albums",
                "UserGeoMedia": "/api/v2/user/scottlefler!geomedia",
                "UserPopularMedia": "/api/v2/user/scottlefler!popularmedia",
                "UserFeaturedAlbums": "/api/v2/user/scottlefler!featuredalbums",
                "UserRecentImages": "/api/v2/user/scottlefler!recentimages",
                "UserImageSearch": "/api/v2/user/scottlefler!imagesearch",
                "UserTopKeywords": "/api/v2/user/scottlefler!topkeywords",
                "UrlPathLookup": "/api/v2/user/scottlefler!urlpathlookup"
            },
            "ResponseLevel": "Public"
        },
        "UriDescription": "User By Nickname",
        "EndpointType": "User",
        "DocUri": "https://api.smugmug.com/api/v2/doc/reference/user.html",
        "Timing": {
            "Total": {
                "time": 0.01602,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}