Response [200 Ok]

Uri /api/v2/album/mFXmPS
UriDescription Album by key
DocUri https://api.smugmug.com/api/v2/doc/reference/album.html
EndpointType Album
Locator Album
LocatorType Object

Album [1 of 1] - Product Shot Photo Candidates
/api/v2/album/mFXmPS

Uri /api/v2/album/mFXmPS
UriDescription Album by key
ResponseLevel Public
AlbumKey mFXmPS
AllowDownloads true
CanBuy false
CanFavorite false
CanShare false
CommerceLightbox true
Description empty string
EXIF false
External true
Filenames false
Geography false
HasDownloadPassword false
ImageCount 38
ImagesLastUpdated 2022-10-06T21:39:48+00:00
Keywords empty string
LastUpdated 2021-03-24T21:54:34+00:00
Name Product Shot Photo Candidates
NiceName Product-Shot-Photo-Candidates
NodeID wGGWdJ
Packages false
PasswordHint empty string
Protected false
SecurityType None
SortDirection Ascending
SortMethod Position
Title Product Shot Photo Candidates
UrlName Product-Shot-Photo-Candidates
UrlPath /Product-Shot-Photo-Candidates
WebUri https://www.smugmug.com/gallery/n-wGGWdJ

Uris

AlbumDownload
/api/v2/album/mFXmPS!download

Uri /api/v2/album/mFXmPS!download
UriDescription Download album
EndpointType AlbumDownload
Locator Download
LocatorType Objects

AlbumHighlightImage
/api/v2/album/mFXmPS!highlightimage

Uri /api/v2/album/mFXmPS!highlightimage
UriDescription Highlight image for album
EndpointType AlbumHighlightImage
Locator AlbumImage
LocatorType Object
AlbumImage [1 of 1]

AlbumImages
/api/v2/album/mFXmPS!images

Uri /api/v2/album/mFXmPS!images
UriDescription Images from album
EndpointType AlbumImages
Locator AlbumImage
LocatorType Objects

AlbumPopularMedia
/api/v2/album/mFXmPS!popularmedia

Uri /api/v2/album/mFXmPS!popularmedia
UriDescription Popular images from album
EndpointType AlbumPopularMedia
Locator AlbumImage
LocatorType Objects

AlbumPricelistExclusions
/api/v2/album/mFXmPS!pricelistexclusions

Uri /api/v2/album/mFXmPS!pricelistexclusions
UriDescription Pricelist information for an Album
EndpointType AlbumPricelistExclusions
Locator AlbumPricelistExclusions
LocatorType Object
AlbumPricelistExclusions [1 of 1]

AlbumPrices
/api/v2/album/mFXmPS!prices

Uri /api/v2/album/mFXmPS!prices
UriDescription Purchasable Skus
EndpointType AlbumPrices
Locator CatalogSkuPrice
LocatorType Objects

AlbumShareUris
/api/v2/album/mFXmPS!shareuris

Uri /api/v2/album/mFXmPS!shareuris
UriDescription URIs that are useful for sharing
EndpointType AlbumShareUris
Locator AlbumShareUris
LocatorType Object
AlbumShareUris [1 of 1]

HighlightImage
/api/v2/highlight/node/wGGWdJ

Uri /api/v2/highlight/node/wGGWdJ
UriDescription Highlight image for a folder, album, or page
EndpointType HighlightImage
Locator Image
LocatorType Object
Image [1 of 1]

Node
/api/v2/node/wGGWdJ

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

NodeCoverImage
/api/v2/node/wGGWdJ!cover

Uri /api/v2/node/wGGWdJ!cover
UriDescription Cover image for a folder, album, or page
EndpointType NodeCoverImage
Locator Image
LocatorType Object
Image [1 of 1]

Timing

Total

cycles 1
objects 0
time 0.04106

Request

Uri /api/v2/album/mFXmPS
Method GET
Version v2

Config

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

Options

Path

  • /api
  • /v2
  • /album
  • /

Notes

  • To sort images manually first set SortMethod to Position
  • When selecting SortMethod=Position, SortMethod is automatically set to Ascending
  • NiceName is deprecated; use UrlName instead
  • Title is deprecated; use Name instead
  • AlbumHighlightImage is deprecated, use HighlightImage instead

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

PATCH

Permissions
  • Modify

DELETE

Permissions
  • Modify

Output Fields

AlbumKey text
AlbumTemplateUri uri Specify default album presets by providing an AlbumTemplateUri.
AllowDownloads boolean
Backprinting text
BoutiquePackaging select
  • No
  • Yes
  • Inherit from User
CanBuy boolean
CanFavorite boolean
CanRank boolean
CanShare boolean Does the owner of this album want it to be shareable?
Clean boolean
Comments boolean
CommerceLightbox boolean
Date datetimeiso8601
Description text
DownloadPassword text
EXIF boolean
External Deprecated as of 2015-09-08 An old setting that no longer has any function
FamilyEdit boolean
FavoriteAlbumUrl fullurl
Filenames boolean
FriendEdit boolean
Geography boolean
HasDownloadPassword boolean
Header select
  • Custom
  • SmugMug
 Appearance
HideOwner boolean
HighlightAlbumImageUri uri
ImageCount integer
ImagesLastUpdated datetimeiso8601 The last time at which images were added, removed, or rearranged in this album
InterceptShipping select
  • No
  • Yes
  • Inherit from User
 Personal Delivery
Keywords text
LargestSize select
  • Medium
  • Large
  • XLarge
  • X2Large
  • X3Large
  • X4Large
  • X5Large
  • 4K
  • 5K
  • Original
LastUpdated datetimeiso8601
Name text
NiceName Deprecated as of 2014-11-20 Use UrlName instead
NodeID text
OriginalSizes integer
Packages boolean Are any packages available for album
PackagingBranding boolean
Password text
PasswordHint text
Printable boolean
PrintmarkUri uri
Privacy select
  • Public
  • Unlisted
  • Private
 "Private" is not supported on legacy accounts
ProofDays integer
ProofDigital boolean
Protected boolean Right-Click Protection
SecurityType select
  • None
  • Password
  • GrantAccess
Share boolean
Slideshow boolean
SmugSearchable select
  • No
  • Inherit from User
SortDirection select
  • Ascending
  • Descending
SortMethod select
  • Position
  • Caption
  • Filename
  • Date Uploaded
  • Date Modified
  • Date Taken
SquareThumbs boolean
TemplateUri uri
ThemeUri uri Only applies to legacy accounts
Title Deprecated as of 2014-11-20 Use Name instead
TotalSizes integer
UploadKey text Guest UploadKey
UrlName text A human-readable name for use in the URL
UrlPath text
Watermark boolean Automatically apply watermark to uploaded images?
WatermarkUri uri
WorldSearchable boolean

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/album/mFXmPS"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "PATCH": {
                "Permissions": [
                    "Modify"
                ]
            },
            "DELETE": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "NiceName",
                "Description": "Use UrlName instead",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": 60,
                "Deprecated": "2014-11-20"
            },
            {
                "Name": "UrlName",
                "Description": "A human-readable name for use in the URL",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": 60
            },
            {
                "Name": "Title",
                "Description": "Use Name instead",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255,
                "Deprecated": "2014-11-20"
            },
            {
                "Name": "Name",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "PrintmarkUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "Printmark"
                ]
            },
            {
                "Name": "WatermarkUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "Watermark"
                ]
            },
            {
                "Name": "ThemeUri",
                "Description": "Only applies to legacy accounts",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "Theme"
                ]
            },
            {
                "Name": "TemplateUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "Template"
                ]
            },
            {
                "Name": "AllowDownloads",
                "Type": "Boolean"
            },
            {
                "Name": "Backprinting",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "BoutiquePackaging",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "Yes",
                    "Inherit from User"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "CanRank",
                "Type": "Boolean"
            },
            {
                "Name": "Clean",
                "Type": "Boolean"
            },
            {
                "Name": "Comments",
                "Type": "Boolean"
            },
            {
                "Name": "Description",
                "Type": "Text",
                "MIN_CHARS": 0,
                "MAX_CHARS": 65535
            },
            {
                "Name": "DownloadPassword",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 50
            },
            {
                "Name": "EXIF",
                "Type": "Boolean"
            },
            {
                "Name": "External",
                "Description": "An old setting that no longer has any function",
                "Type": "Boolean",
                "Deprecated": "2015-09-08"
            },
            {
                "Name": "FamilyEdit",
                "Type": "Boolean"
            },
            {
                "Name": "Filenames",
                "Type": "Boolean"
            },
            {
                "Name": "FriendEdit",
                "Type": "Boolean"
            },
            {
                "Name": "Geography",
                "Type": "Boolean"
            },
            {
                "Name": "Header",
                "Description": "Appearance",
                "Type": "Select",
                "OPTIONS": [
                    "Custom",
                    "SmugMug"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "HideOwner",
                "Type": "Boolean"
            },
            {
                "Name": "InterceptShipping",
                "Description": "Personal Delivery",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "Yes",
                    "Inherit from User"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "Keywords",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "LargestSize",
                "Type": "Select",
                "OPTIONS": [
                    "Medium",
                    "Large",
                    "XLarge",
                    "X2Large",
                    "X3Large",
                    "X4Large",
                    "X5Large",
                    "4K",
                    "5K",
                    "Original"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "PackagingBranding",
                "Type": "Boolean"
            },
            {
                "Name": "Password",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 50
            },
            {
                "Name": "PasswordHint",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "Printable",
                "Type": "Boolean"
            },
            {
                "Name": "Privacy",
                "Description": "\"Private\" is not supported on legacy accounts",
                "Type": "Select",
                "OPTIONS": [
                    "Public",
                    "Unlisted",
                    "Private"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "ProofDays",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "ProofDigital",
                "Type": "Boolean"
            },
            {
                "Name": "Protected",
                "Description": "Right-Click Protection",
                "Type": "Boolean"
            },
            {
                "Name": "Share",
                "Type": "Boolean"
            },
            {
                "Name": "Slideshow",
                "Type": "Boolean"
            },
            {
                "Name": "SmugSearchable",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "Inherit from User"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SortDirection",
                "Type": "Select",
                "OPTIONS": [
                    "Ascending",
                    "Descending"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SortMethod",
                "Type": "Select",
                "OPTIONS": [
                    "Position",
                    "Caption",
                    "Filename",
                    "Date Uploaded",
                    "Date Modified",
                    "Date Taken"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SquareThumbs",
                "Type": "Boolean"
            },
            {
                "Name": "UploadKey",
                "Description": "Guest UploadKey",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Watermark",
                "Description": "Automatically apply watermark to uploaded images?",
                "Type": "Boolean"
            },
            {
                "Name": "WorldSearchable",
                "Type": "Boolean"
            },
            {
                "Name": "SecurityType",
                "Type": "Select",
                "OPTIONS": [
                    "None",
                    "Password",
                    "GrantAccess"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "CommerceLightbox",
                "Type": "Boolean"
            },
            {
                "Name": "HighlightAlbumImageUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "AlbumImage"
                ]
            },
            {
                "Name": "AlbumTemplateUri",
                "Description": "Specify default album presets by providing an AlbumTemplateUri.",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "AlbumTemplate"
                ]
            },
            {
                "Name": "AlbumKey",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "CanBuy",
                "Type": "Boolean"
            },
            {
                "Name": "CanFavorite",
                "Type": "Boolean"
            },
            {
                "Name": "FavoriteAlbumUrl",
                "Type": "FullUrl",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Date",
                "Type": "DateTimeISO8601"
            },
            {
                "Name": "LastUpdated",
                "Type": "DateTimeISO8601"
            },
            {
                "Name": "ImagesLastUpdated",
                "Description": "The last time at which images were added, removed, or rearranged in this album",
                "Type": "DateTimeISO8601"
            },
            {
                "Name": "NodeID",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "OriginalSizes",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "TotalSizes",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "ImageCount",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "UrlPath",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "CanShare",
                "Description": "Does the owner of this album want it to be shareable?",
                "Type": "Boolean"
            },
            {
                "Name": "HasDownloadPassword",
                "Type": "Boolean"
            },
            {
                "Name": "Packages",
                "Description": "Are any packages available for album",
                "Type": "Boolean"
            }
        ],
        "Notes": [
            "To sort images manually first set SortMethod to Position",
            "When selecting SortMethod=Position, SortMethod is automatically set to Ascending",
            "NiceName is deprecated; use UrlName instead",
            "Title is deprecated; use Name instead",
            "AlbumHighlightImage is deprecated, use HighlightImage instead"
        ],
        "ResponseLevels": [
            "Full",
            "Password",
            "Public",
            "GrantAccess"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "album"
            },
            {
                "type": "singleparam",
                "param_name": "albumkey",
                "param_value": "mFXmPS",
                "param_validator": {}
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/album/mFXmPS",
        "Locator": "Album",
        "LocatorType": "Object",
        "Album": {
            "NiceName": "Product-Shot-Photo-Candidates",
            "UrlName": "Product-Shot-Photo-Candidates",
            "Title": "Product Shot Photo Candidates",
            "Name": "Product Shot Photo Candidates",
            "AllowDownloads": true,
            "Description": "",
            "EXIF": false,
            "External": true,
            "Filenames": false,
            "Geography": false,
            "Keywords": "",
            "PasswordHint": "",
            "Protected": false,
            "SortDirection": "Ascending",
            "SortMethod": "Position",
            "SecurityType": "None",
            "CommerceLightbox": true,
            "AlbumKey": "mFXmPS",
            "CanBuy": false,
            "CanFavorite": false,
            "LastUpdated": "2021-03-24T21:54:34+00:00",
            "ImagesLastUpdated": "2022-10-06T21:39:48+00:00",
            "NodeID": "wGGWdJ",
            "ImageCount": 38,
            "UrlPath": "/Product-Shot-Photo-Candidates",
            "CanShare": false,
            "HasDownloadPassword": false,
            "Packages": false,
            "Uri": "/api/v2/album/mFXmPS",
            "WebUri": "https://www.smugmug.com/gallery/n-wGGWdJ",
            "UriDescription": "Album by key",
            "Uris": {
                "AlbumShareUris": {
                    "Uri": "/api/v2/album/mFXmPS!shareuris",
                    "Locator": "AlbumShareUris",
                    "LocatorType": "Object",
                    "UriDescription": "URIs that are useful for sharing",
                    "EndpointType": "AlbumShareUris"
                },
                "Node": {
                    "Uri": "/api/v2/node/wGGWdJ",
                    "Locator": "Node",
                    "LocatorType": "Object",
                    "UriDescription": "Node with the given id.",
                    "EndpointType": "Node"
                },
                "NodeCoverImage": {
                    "Uri": "/api/v2/node/wGGWdJ!cover",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Cover image for a folder, album, or page",
                    "EndpointType": "NodeCoverImage"
                },
                "HighlightImage": {
                    "Uri": "/api/v2/highlight/node/wGGWdJ",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Highlight image for a folder, album, or page",
                    "EndpointType": "HighlightImage"
                },
                "AlbumHighlightImage": {
                    "Uri": "/api/v2/album/mFXmPS!highlightimage",
                    "Locator": "AlbumImage",
                    "LocatorType": "Object",
                    "UriDescription": "Highlight image for album",
                    "EndpointType": "AlbumHighlightImage"
                },
                "AlbumImages": {
                    "Uri": "/api/v2/album/mFXmPS!images",
                    "Locator": "AlbumImage",
                    "LocatorType": "Objects",
                    "UriDescription": "Images from album",
                    "EndpointType": "AlbumImages"
                },
                "AlbumPopularMedia": {
                    "Uri": "/api/v2/album/mFXmPS!popularmedia",
                    "Locator": "AlbumImage",
                    "LocatorType": "Objects",
                    "UriDescription": "Popular images from album",
                    "EndpointType": "AlbumPopularMedia"
                },
                "AlbumDownload": {
                    "Uri": "/api/v2/album/mFXmPS!download",
                    "Locator": "Download",
                    "LocatorType": "Objects",
                    "UriDescription": "Download album",
                    "EndpointType": "AlbumDownload"
                },
                "AlbumPrices": {
                    "Uri": "/api/v2/album/mFXmPS!prices",
                    "Locator": "CatalogSkuPrice",
                    "LocatorType": "Objects",
                    "UriDescription": "Purchasable Skus",
                    "EndpointType": "AlbumPrices"
                },
                "AlbumPricelistExclusions": {
                    "Uri": "/api/v2/album/mFXmPS!pricelistexclusions",
                    "Locator": "AlbumPricelistExclusions",
                    "LocatorType": "Object",
                    "UriDescription": "Pricelist information for an Album",
                    "EndpointType": "AlbumPricelistExclusions"
                }
            },
            "ResponseLevel": "Public"
        },
        "UriDescription": "Album by key",
        "EndpointType": "Album",
        "DocUri": "https://api.smugmug.com/api/v2/doc/reference/album.html",
        "Timing": {
            "Total": {
                "time": 0.04106,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}

Contents

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