SmugMug API
Tutorial
API Concepts
Advanced
- Optimizing response sizes
- Expanding related data
- Configuring expansions
- Rate Limits
- Method and Content Overrides
- Performance Metrics
- Multi-get
- Options requests
Live API Browser
Reference
Album
This reference only covers the most important details. Use the Live API Browser to see everything.
Live example: /api/v2/album/SJT3DX
The album endpoint provides access to album settings and album contents. Albums are also known as galleries.
For a simpler, unified view of folders, albums, and pages, use the Node endpoint instead.
Important fields
Owner-only? | Owner-writeable? | Name | Description |
---|---|---|---|
X | Date | Time when this album was created (which never changes) | |
X | Description | The human-readable description | |
X | External | Is the "allow external embedding" option enabled? | |
ImagesLastUpdated | Time of the last change to the contents or ordering of this album | ||
LastUpdated | Time of the last change to the contents (but not the ordering) of this album | ||
X | Name | The human-readable title | |
X | PasswordHint | The hint for the album-viewing password | |
X | X | Privacy | Private, Unlisted, or Public |
X | X | SmugSearchable | Allow this album to appear in SmugMug search results? Can be "No" or "Inherit from User". |
X | UrlName | The user-configurable component of the album's WebUri | |
WebUri | The album's page on the SmugMug website | ||
X | X | WorldSearchable | Allow this album to appear in external search results? Can be "No" or "Inherit from User". |
Important links
Name | Description |
---|---|
AlbumImages | The images in this album, as album-image relationship objects |
HighlightImage | An image which can be used as a representative of this album |
Node | View this album as a node (only present if the album's owner is on New SmugMug) |
UnlockAlbum | Unlock this album (only present if locked) |
User | The user who owns this album |
Creating an album
To create an album, you must POST to the FolderAlbums endpoint of the folder where you want the new album to be created:
The response, if successful, will be the Album object that was created.