Config

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

Options

Path

  • /api
  • /v2
  • /user
  • /

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

DELETE

Permissions
  • Modify

Output Fields

AccountStatus select
  • Active
  • PastDue
  • Suspended
  • Closed
AccountSubscriptionDiscount floatingpoint
City text
Country text
Domain text
DomainOnly text
Email text
EmailSha256 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
TimeZone text
TotalAccountSize text
TotalUploadedSize text
ViewPassHint text
ViewPassword text
Zip text

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/user/destinationarcticcircle?_shorturis="
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "DELETE": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "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": "EmailSha256",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 64
            },
            {
                "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": "TimeZone",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Zip",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 10
            },
            {
                "Name": "AccountSubscriptionDiscount",
                "Type": "FloatingPoint",
                "MIN_VALUE": 0,
                "MAX_VALUE": 1
            }
        ],
        "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": "destinationarcticcircle",
                "param_validator": {}
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/user/destinationarcticcircle?_shorturis=",
        "Locator": "User",
        "LocatorType": "Object",
        "User": {
            "NickName": "destinationarcticcircle",
            "ViewPassHint": "",
            "RefTag": "qqjqDz",
            "Name": "Destination Arctic Circle",
            "QuickShare": true,
            "Uri": "/api/v2/user/destinationarcticcircle",
            "WebUri": "https://destinationarcticcircle.smugmug.com",
            "UriDescription": "User By Nickname",
            "Uris": {
                "BioImage": "/api/v2/user/destinationarcticcircle!bioimage",
                "CoverImage": "/api/v2/user/destinationarcticcircle!coverimage",
                "UserProfile": "/api/v2/user/destinationarcticcircle!profile",
                "Node": "/api/v2/node/3csBrC",
                "Folder": "/api/v2/folder/user/destinationarcticcircle",
                "Features": "/api/v2/user/destinationarcticcircle!features",
                "SiteSettings": "/api/v2/user/destinationarcticcircle!sitesettings",
                "UserAlbums": "/api/v2/user/destinationarcticcircle!albums",
                "UserGeoMedia": "/api/v2/user/destinationarcticcircle!geomedia",
                "UserPopularMedia": "/api/v2/user/destinationarcticcircle!popularmedia",
                "UserFeaturedAlbums": "/api/v2/user/destinationarcticcircle!featuredalbums",
                "UserRecentImages": "/api/v2/user/destinationarcticcircle!recentimages",
                "UserImageSearch": "/api/v2/user/destinationarcticcircle!imagesearch",
                "UserTopKeywords": "/api/v2/user/destinationarcticcircle!topkeywords",
                "UrlPathLookup": "/api/v2/user/destinationarcticcircle!urlpathlookup"
            },
            "ResponseLevel": "Public"
        },
        "UriDescription": "User By Nickname",
        "EndpointType": "User",
        "DocUri": "https://api.smugmug.com/api/v2/doc/reference/user.html",
        "Timing": {
            "Total": {
                "time": 0.03347,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}