Response [200 Ok]

Uri /api/v2/user/assets?_responseLevel=Password
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] - smugmug assets (assets)
/api/v2/user/assets

Uri /api/v2/user/assets
UriDescription User By Nickname
ResponseLevel Public
Name smugmug assets (assets)
NickName assets
QuickShare true
RefTag PR8alUgjxu9fc
ViewPassHint empty string
WebUri https://assets.smugmug.com

Uris

BioImage
/api/v2/user/assets!bioimage

Uri /api/v2/user/assets!bioimage
UriDescription User BioImage
EndpointType BioImage
Locator BioImage
LocatorType Object
BioImage [1 of 1]

CoverImage
/api/v2/user/assets!coverimage

Uri /api/v2/user/assets!coverimage
UriDescription User CoverImage
EndpointType CoverImage
Locator CoverImage
LocatorType Object
CoverImage [1 of 1]

Features
/api/v2/user/assets!features

Uri /api/v2/user/assets!features
UriDescription User's account features information
EndpointType Features
Locator Features
LocatorType Object
Features [1 of 1]

Folder
/api/v2/folder/user/assets

Uri /api/v2/folder/user/assets
UriDescription A folder or legacy (sub)category by UrlPath
EndpointType Folder
Locator Folder
LocatorType Object
Folder [1 of 1]

Node
/api/v2/node/HSBRm

Uri /api/v2/node/HSBRm
UriDescription Node with the given id.
EndpointType Node
Locator Node
LocatorType Object
Node [1 of 1]

SiteSettings
/api/v2/user/assets!sitesettings

Uri /api/v2/user/assets!sitesettings
UriDescription User site settings
EndpointType SiteSettings
Locator SiteSettings
LocatorType Object
SiteSettings [1 of 1]

UrlPathLookup
/api/v2/user/assets!urlpathlookup

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

UserAlbums
/api/v2/user/assets!albums

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

UserFeaturedAlbums
/api/v2/user/assets!featuredalbums

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

UserGeoMedia
/api/v2/user/assets!geomedia

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

UserImageSearch
/api/v2/user/assets!imagesearch

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

UserPopularMedia
/api/v2/user/assets!popularmedia

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

UserProfile
/api/v2/user/assets!profile

Uri /api/v2/user/assets!profile
UriDescription User's profile information
EndpointType UserProfile
Locator UserProfile
LocatorType Object
UserProfile [1 of 1]

UserRecentImages
/api/v2/user/assets!recentimages

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

UserTopKeywords
/api/v2/user/assets!topkeywords

Uri /api/v2/user/assets!topkeywords
UriDescription User's top keywords
EndpointType UserTopKeywords
Locator UserTopKeywords
LocatorType Object
UserTopKeywords [1 of 1]

Timing

Total

cycles 1
objects 0
time 0.03804

Config

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

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
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/assets?_responseLevel=Password&_accept=text%2Fhtml"
    },
    "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": "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": "assets",
                "param_validator": {}
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/user/assets?_responseLevel=Password",
        "Locator": "User",
        "LocatorType": "Object",
        "User": {
            "NickName": "assets",
            "ViewPassHint": "",
            "RefTag": "PR8alUgjxu9fc",
            "Name": "smugmug assets (assets)",
            "QuickShare": true,
            "Uri": "/api/v2/user/assets",
            "WebUri": "https://assets.smugmug.com",
            "UriDescription": "User By Nickname",
            "Uris": {
                "BioImage": {
                    "Uri": "/api/v2/user/assets!bioimage",
                    "Locator": "BioImage",
                    "LocatorType": "Object",
                    "UriDescription": "User BioImage",
                    "EndpointType": "BioImage"
                },
                "CoverImage": {
                    "Uri": "/api/v2/user/assets!coverimage",
                    "Locator": "CoverImage",
                    "LocatorType": "Object",
                    "UriDescription": "User CoverImage",
                    "EndpointType": "CoverImage"
                },
                "UserProfile": {
                    "Uri": "/api/v2/user/assets!profile",
                    "Locator": "UserProfile",
                    "LocatorType": "Object",
                    "UriDescription": "User's profile information",
                    "EndpointType": "UserProfile"
                },
                "Node": {
                    "Uri": "/api/v2/node/HSBRm",
                    "Locator": "Node",
                    "LocatorType": "Object",
                    "UriDescription": "Node with the given id.",
                    "EndpointType": "Node"
                },
                "Folder": {
                    "Uri": "/api/v2/folder/user/assets",
                    "Locator": "Folder",
                    "LocatorType": "Object",
                    "UriDescription": "A folder or legacy (sub)category by UrlPath",
                    "EndpointType": "Folder"
                },
                "Features": {
                    "Uri": "/api/v2/user/assets!features",
                    "Locator": "Features",
                    "LocatorType": "Object",
                    "UriDescription": "User's account features information",
                    "EndpointType": "Features"
                },
                "SiteSettings": {
                    "Uri": "/api/v2/user/assets!sitesettings",
                    "Locator": "SiteSettings",
                    "LocatorType": "Object",
                    "UriDescription": "User site settings",
                    "EndpointType": "SiteSettings"
                },
                "UserAlbums": {
                    "Uri": "/api/v2/user/assets!albums",
                    "Locator": "Album",
                    "LocatorType": "Objects",
                    "UriDescription": "All of user's albums",
                    "EndpointType": "UserAlbums"
                },
                "UserGeoMedia": {
                    "Uri": "/api/v2/user/assets!geomedia",
                    "Locator": "Image",
                    "LocatorType": "Objects",
                    "UriDescription": "Geotagged images for user",
                    "EndpointType": "UserGeoMedia"
                },
                "UserPopularMedia": {
                    "Uri": "/api/v2/user/assets!popularmedia",
                    "Locator": "Image",
                    "LocatorType": "Objects",
                    "UriDescription": "User's popular images",
                    "EndpointType": "UserPopularMedia"
                },
                "UserFeaturedAlbums": {
                    "Uri": "/api/v2/user/assets!featuredalbums",
                    "Locator": "Album",
                    "LocatorType": "Objects",
                    "UriDescription": "User's featured albums",
                    "EndpointType": "UserFeaturedAlbums"
                },
                "UserRecentImages": {
                    "Uri": "/api/v2/user/assets!recentimages",
                    "Locator": "Image",
                    "LocatorType": "Objects",
                    "UriDescription": "User's recent images",
                    "EndpointType": "UserRecentImages"
                },
                "UserImageSearch": {
                    "Uri": "/api/v2/user/assets!imagesearch",
                    "Locator": "Image",
                    "LocatorType": "Objects",
                    "UriDescription": "Search for user images",
                    "EndpointType": "UserImageSearch"
                },
                "UserTopKeywords": {
                    "Uri": "/api/v2/user/assets!topkeywords",
                    "Locator": "UserTopKeywords",
                    "LocatorType": "Object",
                    "UriDescription": "User's top keywords",
                    "EndpointType": "UserTopKeywords"
                },
                "UrlPathLookup": {
                    "Uri": "/api/v2/user/assets!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.03804,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}

Contents

  1. Response
  2. Request
  3. Config
  4. Options
    1. Available Response Levels
    2. Methods
    3. Available Media Types
    4. Output Fields
  5. JSON