action vimeo_get_albums_alt1 { label: "Get all the albums that belong to a user" provider: vimeo method: GET path: "/me/albums" encoding: json input: { type: "object" properties: { direction: { type: "string" enum: ["asc", "desc"] } page: { type: "number" } per_page: { type: "number" } query: { type: "string" } sort: { type: "string" enum: ["alphabetical", "date", "duration", "videos"] } } additionalProperties: false } output: { type: "array" items: { type: "object" required: ["allow_continuous_play", "allow_downloads", "allow_share", "brand_color", "created_time", "custom_logo", "description", "domain", "duration", "embed", "embed_brand_color", "embed_custom_logo", "hide_nav", "hide_vimeo_logo", "layout", "link", "metadata", "modified_time", "name", "pictures", "privacy", "resource_key", "review_mode", "sort", "theme", "uri", "url", "use_custom_domain", "user", "web_brand_color", "web_custom_logo"] properties: { allow_continuous_play: { type: "boolean" description: "Whether an album should allow continuous play." } allow_downloads: { type: "boolean" description: "Whether an album should allow downloads." } allow_share: { type: "boolean" description: "Whether an album should allow sharing." } brand_color: { type: "string" description: "Hexadecimal color code for the decorative color. For example, album videos use this color for player buttons." } created_time: { type: "string" description: "The time in ISO 8601 format that the album was created." } custom_logo: { description: "The custom logo for this album." type: "object" } description: { type: "string" description: "A brief description of the album's content." } domain: { type: "string" description: "The custom domain a user has selected for their album." } duration: { type: "number" description: "The total duration in seconds of all the videos in the album." } embed: { type: "object" description: "Embed data for the album." required: ["html"] properties: { html: { type: "string" description: "The responsive HTML code to embed the playlist on a website. This is present only when `privacy.view` isn't password and when the album has embeddable videos." } } } embed_brand_color: { type: "boolean" description: "Whether to show the album's custom brand color in the player of the album's embedded playlist." } embed_custom_logo: { type: "boolean" description: "Whether to show the album's custom logo in the player of the album's embedded playlist." } hide_nav: { type: "boolean" description: "Whether to hide the Vimeo navigation when viewing the album." } hide_vimeo_logo: { type: "boolean" description: "Whether to hide the Vimeo logo in the player of the album's embedded playlist." } layout: { type: "string" description: "The album's layout preference" enum: ["grid", "player"] } link: { type: "string" description: "The URL to access the album." } metadata: { type: "object" description: "Metadata about the album." required: ["connections", "interactions"] properties: { connections: { type: "object" description: "A collection of information that is connected to this resource." required: ["videos"] properties: { videos: { type: "object" description: "Information about the videos that belong to this album." required: ["options", "total", "uri"] properties: { options: { type: "array" description: "An array of the HTTP methods permitted on this URI." items: { type: "string" } } total: { type: "number" description: "The total number of videos on this connection." } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } } } interactions: { type: "object" description: "A list of resource URIs related to the album." required: ["add_custom_thumbnails", "add_logos", "add_videos"] properties: { add_custom_thumbnails: { type: "object" description: "An action indicating that the authenticated user is an admin of the album and may therefore add custom thumbnails. This data requires a bearer token with the `private` scope." required: ["options", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI. This data requires a bearer token with the `private` scope." items: { type: "string" } } uri: { type: "string" description: "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope." } } } add_logos: { type: "object" description: "An action indicating that the authenticated user is an admin of the album and may therefore add custom logos. This data requires a bearer token with the `private` scope." required: ["options", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI. This data requires a bearer token with the `private` scope." items: { type: "string" } } uri: { type: "string" description: "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope." } } } add_videos: { type: "object" description: "An action indicating that the authenticated user is an admin of the album and may therefore add videos. This data requires a bearer token with the `private` scope." required: ["options", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods allowed on this URI. This data requires a bearer token with the `private` scope." items: { type: "string" } } uri: { type: "string" description: "The API URI that resolves to the connection data. This data requires a bearer token with the `private` scope." } } } } } } } modified_time: { type: "string" description: "The time in ISO 8601 format when the album was last modified." } name: { type: "string" description: "The album's display name." } pictures: { description: "The active image for the album; defaults to the thumbnail of the last video added to the album." type: "object" } privacy: { type: "object" description: "The privacy settings of the album." required: ["view"] properties: { password: { type: "string" description: "The privacy-enabled password to see this album. Present only when `privacy.view` is `password`." } view: { type: "string" description: "Who can view the album:\n\nOption descriptions:\n * `anybody` - Anyone can view the album.\n * `embed_only` - Only owner can see album, can be embedded off-site\n * `password` - Only those with the password can view the album.\n" enum: ["anybody", "embed_only", "password"] } } } resource_key: { type: "string" description: "The album resource key." } review_mode: { type: "boolean" description: "Whether album videos should use the review mode URL." } sort: { type: "string" description: "Sort type of the album." enum: ["added_first", "added_last", "alphabetical", "arranged", "comments", "likes", "newest", "oldest", "plays"] } theme: { type: "string" description: "The album's color theme preference" enum: ["dark", "standard"] } uri: { type: "string" description: "The album's URI." } url: { type: "string" description: "The custom Vimeo URL a user has selected for their album." } use_custom_domain: { type: "boolean" description: "Whether the user has opted in to use a custom domain for their album." } user: { description: "The owner of the album." type: "object" } web_brand_color: { type: "boolean" description: "Whether an album should show the brand color in the web layout." } web_custom_logo: { type: "boolean" description: "Whether an album's custom logo should be shown in the web layout." } } } } }