Outdated Please upgrade to the latest version.

smugmug.albums.get

Retrieves a list of albums for a given user.

Arguments

• SessionID - string.
• NickName - string (optional).
• Heavy - boolean (optional).
• SitePassword - string (optional).

Result

    standard response

• array Albums
  • struct Album
    • integer id
    • string Key
    • string Title
    • struct Category
      • string id
      • string Name
    • struct SubCategory
      • string id
      • string Name

    heavy response

• array Albums
  • struct Album
    • integer id
    • string Key
    • string Title
    • struct Category
      • string id
      • string Name
    • struct SubCategory
      • string id
      • string Name
    • string Description
    • string Keywords
    • boolean Geography (owner)
    • integer Position
    • struct Hightlight (owner)
      • string id
    • integer ImageCount
    • string LastUpdated
    • boolean Header (owner, power & pro only)
    • boolean Clean (owner)
    • boolean EXIF (owner)
    • boolean Filenames (owner)
    • struct Template (owner)
      • string id
    • string SortMethod (owner)
    • boolean SortDirection (owner)
    • string Password (owner)
    • string PasswordHint (owner)
    • boolean Public (owner)
    • boolean WorldSearchable (owner)
    • boolean SmugSearchable (owner)
    • boolean External (owner)
    • boolean Protected (owner, power & pro only)
    • boolean Watermarking (owner, pro only)
    • struct Watermark (owner, pro only)
      • string id
    • boolean HideOwner (owner)
    • boolean Larges (owner, pro only)
    • boolean XLarges (owner, pro only)
    • boolean X2Larges (owner)
    • boolean X3Larges (owner)
    • boolean Originals (owner)
    • boolean CanRank (owner)
    • boolean FriendEdit (owner)
    • boolean FamilyEdit (owner)
    • boolean Comments (owner)
    • boolean Share (owner)
    • boolean Printable (owner)
    • int ColorCorrection (owner)
    • boolean DefaultColor (owner, pro only)  deprecated
    • integer ProofDays (owner, pro only)
    • string Backprinting (owner, pro only)
    • float UnsharpAmount (owner, power & pro only)
    • float UnsharpRadius (owner, power & pro only)
    • float UnsharpThreshold (owner, power & pro only)
    • float UnsharpSigma (owner, power & pro only)
    • struct Community (owner)
      • string id

Fault Codes

• 4 - "invalid user (message)"
• 15 - "empty set - no albums found"
• 18 - "invalid API key"Sample Request

  http://api.smugmug.com/hack/json/1.2.0/?method=smugmug.albums.get&SessionID=<SESSION ID>
  

Sample Responses

REST

JSON

PHP

XML-RPC