action vimeo_get_project_videos_alt1 { label: "Get all the videos in a project" description: "This method gets all the videos that belong to the specified project." provider: vimeo method: GET path: "/me/projects/{project_id}/videos" encoding: json input: { type: "object" properties: { direction: { type: "string" enum: ["asc", "desc"] } page: { type: "number" } per_page: { type: "number" } project_id: { type: "number" } sort: { type: "string" enum: ["alphabetical", "date", "default", "duration", "last_user_action_event_date"] } } required: ["project_id"] additionalProperties: false } output: { type: "array" items: { type: "object" required: ["categories", "content_rating", "context", "created_time", "description", "duration", "embed", "height", "language", "license", "link", "metadata", "modified_time", "name", "pictures", "privacy", "release_time", "resource_key", "spatial", "stats", "status", "tags", "transcode", "upload", "uri", "user", "width"] properties: { categories: { type: "array" description: "The categories to which this video belongs." items: { type: "object" required: ["last_video_featured_time", "link", "metadata", "name", "parent", "pictures", "resource_key", "top_level", "uri"] properties: { icon: { description: "The active icon for the category." type: "object" } last_video_featured_time: { type: "string" description: "The last time, in ISO 8601 format, that a video was featured." } link: { type: "string" description: "The URL to access the category in a browser." } metadata: { type: "object" description: "Metadata about the category." required: ["connections", "interactions"] properties: { connections: { type: "object" description: "A collection of information that is connected to this resource." required: ["channels", "groups", "users", "videos"] properties: { channels: { type: "object" description: "Information about the channels related to this category." required: ["options", "total", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "object" additionalProperties: true } } total: { type: "number" description: "The total number of channels on this connection." } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } groups: { type: "object" description: "Information about the groups related to this category." required: ["options", "total", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "object" additionalProperties: true } } total: { type: "number" description: "The total number of groups on this connection." } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } users: { type: "object" description: "Information about the users related to this category." required: ["options", "total", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "object" additionalProperties: true } } total: { type: "number" description: "The total number of users on this connection." } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } videos: { type: "object" description: "Information about the videos related to this category." required: ["options", "total", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "object" additionalProperties: true } } 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: "The permissible actions related to the category." required: ["follow"] properties: { follow: { type: "object" description: "An action indicating if the authenticated user has followed this category." required: ["added", "added_time", "uri"] properties: { added: { type: "boolean" description: "Whether the authenticated user has followed this category." } added_time: { type: "string" description: "The time in ISO 8601 format that the user followed this category, or the null value if the user hasn't followed this category." } uri: { type: "string" description: "The URI for following or unfollowing this category: PUT to this URI to follow the category, or DELETE to this URI to unfollow the category." } } } } } } } name: { type: "string" description: "The display name that identifies the category." } parent: { type: "object" description: "The container of this category's parent category, if the current category is a subcategory." required: ["link", "name", "uri"] properties: { link: { type: "string" description: "The URL to access the parent category in a browser." } name: { type: "string" description: "The display name that identifies the parent category." } uri: { type: "string" description: "The unique identifier to access the parent of this category resource." } } } pictures: { description: "The active picture for this category; defaults to vertical color bars." type: "object" } resource_key: { type: "string" description: "The resource key of the category." } subcategories: { type: "array" description: "All the subcategories that belong to this category, if the current category is a top-level parent." items: { type: "object" required: ["link", "name", "uri"] properties: { link: { type: "string" description: "The URL to access the subcategory in a browser." } name: { type: "string" description: "The display name that identifies the subcategory." } uri: { type: "string" description: "The unique identifier to access the subcategory resource." } } } } top_level: { type: "boolean" description: "Whether the category isn't a subcategory of another category." } uri: { type: "string" description: "The unique identifier to access the category resource." } } } } content_rating: { type: "array" description: "The content ratings of this video." items: { type: "string" } } context: { type: "object" description: "The context of the video's subscription, if this video is part of a subscription." required: ["action", "resource", "resource_type"] properties: { action: { type: "string" description: "The contextual action:\n\nOption descriptions:\n * `Added to` - An Added To action.\n * `Appearance by` - An Appearance By action.\n * `Liked by` - A Liked By action.\n * `Uploaded by` - An Unloaded By action.\n" enum: ["Added to", "Appearance by", "Liked by", "Uploaded by"] } resource: { type: "object" description: "The contextual resource: a user, group, or channel representation, or an object of a tag." } resource_type: { type: "string" description: "The contextual resource type." } } } created_time: { type: "string" description: "The time in ISO 8601 format when the video was created." } description: { type: "string" description: "A brief explanation of the video's content." } duration: { type: "number" description: "The video's duration in seconds." } embed: { description: "Information about embedding this video." type: "object" } height: { type: "number" description: "The video's height in pixels." } language: { type: "string" description: "The video's primary language." } last_user_action_event_date: { type: "string" description: "The time in ISO 8601 format when the user last modified the video." } license: { type: "string" description: "The [Creative Commons](http://creativecommons.org/licenses/) license used for the video:\n\nOption descriptions:\n * `by` - Attribution\n * `by-nc` - Attribution Non-Commercial\n * `by-nc-nd` - Attribution Non-Commercial No Derivatives\n * `by-nc-sa` - Attribution Non-Commercial Share Alike\n * `by-nd` - Attribution No Derivatives\n * `by-sa` - Attribution Share Alike\n * `cc0` - Public Domain Dedication\n" enum: ["by", "by-nc", "by-nc-nd", "by-nc-sa", "by-nd", "by-sa", "cc0"] } link: { type: "string" description: "The link to the video." } metadata: { type: "object" description: "The video's metadata." required: ["connections", "interactions"] properties: { connections: { type: "object" description: "A list of resource URIs related to the video." required: ["comments", "credits", "likes", "ondemand", "pictures", "playback", "recommendations", "related", "season", "texttracks", "trailer", "users_with_access", "versions"] properties: { comments: { type: "object" description: "Information about the comments on this video." required: ["options", "total", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } total: { type: "number" description: "The total number of comments on this connection." } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } credits: { type: "object" description: "Information about the users credited in this video." properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } total: { type: "number" description: "The total number of users on this connection." } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } likes: { type: "object" description: "Information about the users who have liked this video." required: ["options", "total", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } total: { type: "number" description: "The total number of likes on this connection." } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } ondemand: { type: "object" description: "Information about this video's ondemand data." required: ["options", "resource_key", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } resource_key: { type: "string" description: "The On Demand connection resource key." } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } pictures: { type: "object" description: "Information about this video's thumbnails." required: ["options", "total", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods allowed on this URI." items: { type: "string" } } total: { type: "number" description: "Total number of thumbnails on this connection." } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } playback: { type: "object" description: "The DRM playback status connection for this video." required: ["options", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } recommendations: { type: "object" description: "The recommendations for this video." properties: { options: { type: "array" description: "An array of HTTP methods allowed on this URI." items: { type: "string" } } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } related: { type: "object" description: "Related content for this video." properties: { options: { type: "array" description: "An array of HTTP methods allowed on this URI." items: { type: "string" } } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } season: { type: "object" description: "Information about the video's season." required: ["name", "options", "uri"] properties: { name: { type: "string" description: "The name of this season." } options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } texttracks: { type: "object" description: "Information about this video's text tracks." required: ["options", "total", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } total: { type: "number" description: "The total number of text tracks on this connection." } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } trailer: { type: "object" description: "Information about this video's VOD trailer." required: ["options", "resource_key", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } resource_key: { type: "string" description: "The trailer connection resource key." } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } users_with_access: { type: "object" description: "Information about the user privacy of this video, if the video privacy is `users`." required: ["options", "total", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } total: { type: "number" description: "The total number of users on this connection." } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } versions: { type: "object" description: "Information about the versions of this video." required: ["options", "total", "uri"] properties: { current_uri: { type: "string" description: "The URI of the current version of the video." } options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } total: { type: "number" description: "The total number of versions 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 video." required: ["buy", "channel", "like", "rent", "report", "watched", "watchlater"] properties: { buy: { type: "object" description: "The Buy interaction for a On Demand video." required: ["currency", "display_price", "download", "drm", "link", "price", "purchase_time", "stream", "uri"] properties: { currency: { type: "string" description: "The currency code for the current user's region." } display_price: { type: "string" description: "Formatted price to display to buy an On Demand video." } download: { type: "string" description: "The user's download access to this On Demand video:\n\nOption descriptions:\n * `available` - The video is available for download.\n * `purchased` - The user has purchased the video.\n * `restricted` - The user isn't permitted to download the video.\n * `unavailable` - The video isn't available for download.\n" enum: ["available", "purchased", "restricted", "unavailable"] } drm: { type: "boolean" description: "Whether the video has DRM." } link: { type: "string" description: "The URL to buy the On Demand video on Vimeo." } price: { type: "number" description: "The numeric value of the price for buying the On Demand video." } purchase_time: { type: "string" description: "The time in ISO 8601 format when the On Demand video was purchased." } stream: { type: "string" description: "The user's streaming access to this On Demand video:\n\nOption descriptions:\n * `available` - The video is available for streaming.\n * `purchased` - The user has purchased the video.\n * `restricted` - The user isn't permitted to stream the video.\n * `unavailable` - The video isn't available for streaming\n" enum: ["available", "purchased", "restricted", "unavailable"] } uri: { type: "string" description: "The product URI to purchase the On Demand video." } } } channel: { type: "object" description: "When a video is referenced by a channel URI, if the user is a moderator of the channel, include information about removing the video from the channel." required: ["options", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } like: { type: "object" description: "Information about whether the authenticated user has liked this video." required: ["added", "added_time", "options", "uri"] properties: { added: { type: "boolean" description: "Whether the user has liked the video." } added_time: { type: "string" description: "The time in ISO 8601 format when the user liked the video." } options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } rent: { type: "object" description: "The Rent interaction for an On Demand video." required: ["currency", "display_price", "drm", "expires_time", "link", "price", "purchase_time", "stream", "uri"] properties: { currency: { type: "string" description: "The currency code for the current user's region." } display_price: { type: "string" description: "Formatted price to display to rent an On Demand video." } drm: { type: "boolean" description: "Whether the video has DRM." } expires_time: { type: "string" description: "The time in ISO 8601 format when the rental period for the video expires." } link: { type: "string" description: "The URL to rent the On Demand video on Vimeo." } price: { type: "number" description: "The numeric value of the price for buying the On Demand video." } purchase_time: { type: "string" description: "The time in ISO 8601 format when the On Demand video was rented." } stream: { type: "string" description: "The user's streaming access to this On Demand video:\n\nOption descriptions:\n * `available` - The video is available for streaming.\n * `purchased` - The user has purchased the video.\n * `restricted` - The user isn't permitted to stream the video.\n * `unavailable` - The video isn't available for streaming.\n" enum: ["available", "purchased", "restricted", "unavailable"] } uri: { type: "string" description: "The product URI to rent the On Demand video." } } } report: { type: "object" description: "Information about where and how to report a video." required: ["options", "reason", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } reason: { type: "array" description: "A list of valid reasons for reporting a video." items: { type: "string" } } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } subscribe: { type: "object" description: "Subscription information for an On Demand video." properties: { drm: { type: "boolean" description: "Whether the video has DRM." } expires_time: { type: "string" description: "The time in ISO 8601 format when the subscription expires." } purchase_time: { type: "string" description: "The tine in ISO 8601 format when the subscription was purchased." } stream: { type: "string" description: "The stream type." } } } watched: { type: "object" description: "Information about removing this video from the user's list of watched videos." required: ["added", "added_time", "options", "uri"] properties: { added: { type: "boolean" description: "Whether the user has watched the video." } added_time: { type: "string" description: "The time in ISO 8601 format when the user watched the video." } options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } watchlater: { type: "object" description: "Information about whether this video appears on the authenticated user's Watch Later list." required: ["added", "added_time", "options", "uri"] properties: { added: { type: "boolean" description: "Whether the user has added the video to their Watch later list." } added_time: { type: "string" description: "The time in ISO 8601 format when the user added the video to their Watch Later list." } options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "string" } } uri: { type: "string" description: "The API URI that resolves to the connection data." } } } } } } } modified_time: { type: "string" description: "The time in ISO 8601 format when the video metadata was last modified." } name: { type: "string" description: "The video's title." } parent_folder: { description: "Information about the folder that contains this video." type: "object" } password: { type: "string" description: "The privacy-enabled password to watch this video. Only users can see their own video passwords. This data requires a bearer token with the `private` scope." } pictures: { description: "The active picture for this video." type: "object" } privacy: { type: "object" description: "The video's privacy setting." required: ["add", "comments", "download", "embed", "view"] properties: { add: { type: "boolean" description: "Whether the video can be added to collections." } comments: { type: "string" description: "Who can comment on the video:\n\nOption descriptions:\n * `anybody` - Anyone can comment on the video.\n * `contacts` - Only contacts can comment on the video.\n * `nobody` - No one can comment on the video.\n" enum: ["anybody", "contacts", "nobody"] } download: { type: "boolean" description: "The video's download permission setting." } embed: { type: "string" description: "The video's embed permission setting:\n\nOption descriptions:\n * `private` - The video is private.\n * `public` - Anyone can embed the video.\n" enum: ["private", "public"] } view: { type: "string" description: "The general privacy setting for the video:\n\nOption descriptions:\n * `anybody` - Anyone can view the video.\n * `contacts` - Only contacts can view the video.\n * `disable` - Hide from vimeo\n * `nobody` - No one besides the owner can view the video.\n * `password` - Anyone with the video's password can view the video.\n * `unlisted` - Not searchable from vimeo.com\n * `users` - Only people with a Vimeo account can view the video.\n" enum: ["anybody", "contacts", "disable", "nobody", "password", "unlisted", "users"] } } } release_time: { type: "string" description: "The time in ISO 8601 format when the video was released." } resource_key: { type: "string" description: "The resource key string of the video." } spatial: { type: "object" description: "360 spatial data." required: ["director_timeline", "field_of_view", "projection", "stereo_format"] properties: { director_timeline: { type: "array" description: "360 director timeline." items: { type: "object" properties: { pitch: { type: "number" description: "The director timeline pitch, from -90 (minimum) to 90 (maximum)." } roll: { type: "number" description: "The director timeline roll." } time_code: { type: "number" description: "The director timeline time code." } yaw: { type: "number" description: "The director timeline yaw, from 0 (minimum) to 360 (maximum)." } } } } field_of_view: { type: "number" description: "The 360 field of view, from 30 (minimum) to 90 (maximum). The default is 50." } projection: { type: "string" description: "The 360 spatial projection:\n\nOption descriptions:\n * `cubical` - The spatial projection is cubical.\n * `cylindrical` - The spatial projection is cylindrical.\n * `dome` - The spatial projection is dome-shaped.\n * `equirectangular` - The spatial projection is equirectangular.\n * `pyramid` - The spatial projection is pyramid-shaped.\n" enum: ["cubical", "cylindrical", "dome", "equirectangular", "pyramid"] } stereo_format: { type: "string" description: "The 360 stereo format:\n\nOption descriptions:\n * `left-right` - The stereo format is left-right.\n * `mono` - The audio is monaural.\n * `top-bottom` - The stereo format is top-bottom.\n" enum: ["left-right", "mono", "top-bottom"] } } } stats: { type: "object" description: "A collection of stats associated with this video." required: ["plays"] properties: { plays: { type: "number" description: "The current total number of times that the video has been played." } } } status: { type: "string" description: "The status code for the availability of the video. This field is deprecated in favor of `upload` and `transcode`.\n\nOption descriptions:\n * `available` - The video is available.\n * `quota_exceeded` - The user's quota is exceeded with this video.\n * `total_cap_exceeded` - The user has exceeded their total cap with this video.\n * `transcode_starting` - Transcoding is beginning for the video.\n * `transcoding` - Transcoding is underway for the video.\n * `transcoding_error` - There was an error in transcoding the video.\n * `unavailable` - The video is unavailable.\n * `uploading` - The video is being uploaded.\n * `uploading_error` - There was an error in uploading the video.\n" enum: ["available", "quota_exceeded", "total_cap_exceeded", "transcode_starting", "transcoding", "transcoding_error", "unavailable", "uploading", "uploading_error"] } tags: { type: "array" description: "An array of all tags assigned to this video." items: { type: "object" required: ["canonical", "metadata", "name", "resource_key", "uri"] properties: { canonical: { type: "string" description: "The normalized canonical tag name." } metadata: { type: "object" description: "Metadata about the group." required: ["connections"] 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 related to this tag." required: ["options", "total", "uri"] properties: { options: { type: "array" description: "An array of HTTP methods permitted on this URI." items: { type: "object" additionalProperties: true } } 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." } } } } } } } name: { type: "string" description: "The tag value." } resource_key: { type: "string" description: "The tag's resource key string." } uri: { type: "string" description: "The canonical relative URI of the tag." } } } } transcode: { type: "object" description: "The transcode information for a video upload." properties: { status: { type: "string" description: "Status code for this video's availability." enum: ["complete", "error", "in_progress"] } } } upload: { type: "object" description: "The upload information for this video." required: ["status"] properties: { approach: { type: "string" description: "The approach for uploading the video." enum: ["post", "pull", "streaming", "tus"] } complete_uri: { type: "string" description: "The URI for completing the upload." } form: { type: "string" description: "The HTML form for uploading a video through the post approach." } link: { type: "string" description: "The link of the video to capture through the pull approach." } redirect_url: { type: "string" description: "The redirect URL for the upload app." } size: { type: "number" description: "The file size in bytes of the uploaded video." } status: { type: "string" description: "The status code for the availability of the uploaded video:\n\nOption descriptions:\n * `complete` - The upload is complete.\n * `error` - The upload ended with an error.\n * `in_progress` - The upload is underway.\n" enum: ["complete", "error", "in_progress"] } upload_link: { type: "string" description: "The link for sending video file data." } } } uri: { type: "string" description: "The video's canonical relative URI." } user: { description: "The video owner." type: "object" } width: { type: "number" description: "The video's width in pixels." } } } } }