> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.staging.frame.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.staging.frame.io/_mcp/server. # List version stacks GET https://api.frame.io/v4/accounts/{account_id}/folders/{folder_id}/version_stacks List version stacks in a given folder. Rate Limits: 5 calls per 1 second(s) per account\_user Reference: https://developer.staging.frame.io/platform/api-reference/version-stacks/list ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `account_id` (string, required) - `folder_id` (string, required) ### Query parameters - `include` (enum, optional) - Allowed values: `media_links`, `media_links.original`, `media_links.thumbnail`, `media_links.video_h264_180`, `media_links.high_quality`, `media_links.efficient`, `creator`, `project`, `project.owner`, `metadata` - `after` (string, optional) — Opaque Cursor query param for requests returning paginated results. NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable. - `page_size` (integer, optional, default: 50) - `include_total_count` (boolean, optional, default: false) ## Response ### 200 OK - `data` (list of VersionStackWithIncludes, required) - `links` (Links, required) — Links to paginated data - `total_count` (integer, optional, nullable) — Total count ## Errors ### 400 Bad Request Error Bad Request - `errors` (list of BadRequestErrorsItems, required) ### 401 Unauthorized Error Unauthorized - `errors` (list of UnauthorizedErrorsItems, required) ### 403 Forbidden Error Forbidden - `errors` (list of ForbiddenErrorsItems, required) ### 404 Not Found Error Not Found - `errors` (list of NotFoundErrorsItems, required) ### 422 Unprocessable Entity Error Unprocessable Entity - `errors` (list of UnprocessableEntityErrorsItems, required) ### 429 Too Many Requests Error Too Many Requests - `errors` (list of TooManyRequestsErrorsItems, required) ## Types ### VersionStackWithIncludes - `created_at` (string, required) — Creation timestamp - `head_version` (FileWithIncludes, required) - `id` (string, required) — Version Stack ID - `name` (string, required) — Version Stack Name - `parent_id` (string, required, nullable) — Parent Folder ID - `project_id` (string, required) — Project ID - `type` (enum, required) - Allowed values: `file`, `folder`, `version_stack` - `updated_at` (string, required) — Update timestamp - `view_url` (string, required) — URL to view the asset in the Frame.io web application - `creator` (User, optional) — User details - `metadata` (list of MetadataField, optional) — File attributes - `project` (ProjectWithIncludes, optional) ### Links Links to paginated data - `next` (string, required, nullable) — "Link to next page of data. This link is the request path with the addition of the `after` query parameter to fetch the next page of results. Optional query parameters `page_size` and `include_total_count` are supported when paginating data." ### BadRequestErrorsItems - `detail` (string, required) - `source` (BadRequestErrorsItemsSource, optional) - `title` (string, optional) ### UnauthorizedErrorsItems - `detail` (string, required) - `source` (UnauthorizedErrorsItemsSource, optional) - `title` (string, optional) ### ForbiddenErrorsItems - `detail` (string, required) - `source` (ForbiddenErrorsItemsSource, optional) - `title` (string, optional) ### NotFoundErrorsItems - `detail` (string, required) - `source` (NotFoundErrorsItemsSource, optional) - `title` (string, optional) ### UnprocessableEntityErrorsItems - `detail` (string, required) - `source` (UnprocessableEntityErrorsItemsSource, optional) - `title` (string, optional) ### TooManyRequestsErrorsItems - `detail` (string, required) - `source` (TooManyRequestsErrorsItemsSource, optional) - `title` (string, optional) ### FileWithIncludes - `created_at` (string, required) — Creation timestamp - `file_size` (integer, required) — File size in bytes - `id` (string, required) — File ID - `media_type` (string, required) — File media type - `name` (string, required) — File Name - `parent_id` (string, required, nullable) — Parent Folder or Version Stack ID - `project_id` (string, required) — Project ID - `status` (enum, required) - Allowed values: `created`, `transcoded`, `uploaded` - `type` (enum, required) - Allowed values: `file`, `folder`, `version_stack` - `updated_at` (string, required) — Update timestamp - `view_url` (string, required) — URL to view the asset in the Frame.io web application - `creator` (User, optional) — User details - `media_links` (MediaLinksCollection, optional) - `metadata` (list of MetadataField, optional) — File attributes - `project` (ProjectWithIncludes, optional) ### User User details - `active` (boolean, required, nullable) — User active status - `avatar_url` (string, required, nullable) — User avatar image url - `email` (string, required) — User email - `id` (string, required, nullable) — User ID - can be null for invited users with no frame account - `name` (string, required, nullable) — User name - `adobe_user_id` (string, optional, nullable) — Adobe user ID ### MetadataField - `field_type`: `date` (date) - `field_definition_id` (string, required) — Field definition ID - `field_definition_name` (string, required) — Field definition name - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated. - `value` (string, required, nullable) - `field_type`: `long_text` (long_text) - `field_definition_id` (string, required) — Field definition ID - `field_definition_name` (string, required) — Field definition name - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated. - `value` (string, required, nullable) - `field_type`: `number` (number) - `field_definition_id` (string, required) — Field definition ID - `field_definition_name` (string, required) — Field definition name - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated. - `value` (double, required, nullable) - `field_type`: `rating` (rating) - `field_definition_id` (string, required) — Field definition ID - `field_definition_name` (string, required) — Field definition name - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated. - `value` (integer, required, nullable) - `field_type`: `select` (select) - `field_definition_id` (string, required) — Field definition ID - `field_definition_name` (string, required) — Field definition name - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated. - `value` (list of SelectOption, required) - `field_options` (list of SelectOption, optional) - `field_type`: `select_multi` (select_multi) - `field_definition_id` (string, required) — Field definition ID - `field_definition_name` (string, required) — Field definition name - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated. - `value` (list of SelectOption, required) - `field_options` (list of SelectOption, optional) - `field_type`: `text` (text) - `field_definition_id` (string, required) — Field definition ID - `field_definition_name` (string, required) — Field definition name - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated. - `value` (string, required, nullable) - `field_type`: `toggle` (toggle) - `field_definition_id` (string, required) — Field definition ID - `field_definition_name` (string, required) — Field definition name - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated. - `value` (boolean, required, nullable) - `field_type`: `user_multi` (user_multi) - `field_definition_id` (string, required) — Field definition ID - `field_definition_name` (string, required) — Field definition name - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated. - `value` (list of UserValue, required) - `custom_members` (list of UserValue, optional) — Populated with costum member options only if `member_options_type` is set to 'custom'. - `member_options_type` (enum, optional) - Allowed values: `custom`, `all_project_members` - `field_type`: `user_single` (user_single) - `field_definition_id` (string, required) — Field definition ID - `field_definition_name` (string, required) — Field definition name - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated. - `value` (list of UserValue, required) - `custom_members` (list of UserValue, optional) — Populated with costum member options only if `member_options_type` is set to 'custom'. - `member_options_type` (enum, optional) - Allowed values: `custom`, `all_project_members` - `field_type`: `users` (users) - `field_definition_id` (string, required) — Field definition ID - `field_definition_name` (string, required) — Field definition name - `mutable` (boolean, required) — Metadata mutability. System field values cannot be updated. - `value` (list of UserValue, required) - `custom_members` (list of UserValue, optional) — Populated with costum member options only if `member_options_type` is set to 'custom'. - `member_options_type` (enum, optional) - Allowed values: `custom`, `all_project_members` ### ProjectWithIncludes - `created_at` (string, required) — Created Timestamp - `description` (string, required, nullable) — Project Description - `id` (string, required) — Project ID - `name` (string, required) — Project Name - `root_folder_id` (string, required) — Root Folder ID - `storage` (integer, required, default: 0) — Storage Usage - `updated_at` (string, required) — Updated Timestamp - `view_url` (string, required) — URL to view the project in the Frame.io web application - `workspace_id` (string, required) — Workspace ID - `owner` (User, optional) — User details ### BadRequestErrorsItemsSource - `pointer` (string, optional) ### UnauthorizedErrorsItemsSource - `pointer` (string, optional) ### ForbiddenErrorsItemsSource - `pointer` (string, optional) ### NotFoundErrorsItemsSource - `pointer` (string, optional) ### UnprocessableEntityErrorsItemsSource - `pointer` (string, optional) ### TooManyRequestsErrorsItemsSource - `pointer` (string, optional) ### MediaLinksCollection - `efficient` (MediaLinkCommon, optional) - `high_quality` (MediaLinkCommon, optional) - `original` (OriginalMediaLink, optional) - `thumbnail` (RenditionMediaLink, optional) - `video_h264_180` (RenditionMediaLink, optional) ### SelectOption - `display_name` (string, required) — Option display name - `id` (string, required) — Option ID ### UserValue - `id` (string, required) — User Id or Account User Group Id - `type` (enum, required) - Allowed values: `user`, `account_user_group` ### MediaLinkCommon - `download_url` (string, required, nullable) — URL to download the media file. HTTP response headers will include Content-Disposition = 'attachment;filename=\'. Watermarks may be applied for transcode links as per Account settings and User permissions. ### OriginalMediaLink - `download_url` (string, required, nullable) — URL to download the media file. HTTP response headers will include Content-Disposition = 'attachment;filename=\'. Watermarks may be applied for transcode links as per Account settings and User permissions. - `inline_url` (string, required, nullable) — URL to view the media file in a web browser in its original resolution and media type. HTTP response headers will include Content-Disposition = 'inline;filename=\'. ### RenditionMediaLink - `download_url` (string, required, nullable) — URL to download the media file. HTTP response headers will include Content-Disposition = 'attachment;filename=\'. Watermarks may be applied for transcode links as per Account settings and User permissions. - `url` (string, required, nullable) — URL to transcoded media that won't include any Content-Disposition header in the response. Watermarks may be applied as per Account settings and User permissions. Media content may be streamed (e.g. when watermarks are required). Clients may issue a HEAD request to determine whether Content-Length and/or Accept-Ranges headers are present in order to determine whether the content can be downloaded in parallel chunks. ## Examples **Response** ```json { "data": [ { "created_at": "2023-09-25T19:18:29.614189Z", "head_version": { "created_at": "2023-09-25T19:18:29.614189Z", "file_size": 1137444, "id": "67b11ddd-fadc-45f0-ac1d-2f8ae929126c", "media_type": "image/png", "name": "asset.png", "parent_id": "06dd2657-2d56-4c80-afcc-482284725745", "project_id": "abdc8443-a4a1-4179-b052-00fe593c841e", "status": "created", "type": "file", "updated_at": "2024-02-07T16:44:41.986478Z", "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/view/5a89a9fb-0900-4b23-826b-127b90e4db4c", "creator": { "active": true, "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN", "email": "user_email@example.com", "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e", "name": "Jon Doe" }, "media_links": { "high_quality": { "download_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN" }, "original": { "download_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN", "inline_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=inline%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragSDFXDFh&1Key-Pair-Id=KKI497NESTHMN" }, "thumbnail": { "download_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN", "url": "https://picture2.frame.io/image/s3://frameio-assets-development/image/cd58cb8e-24b3-4498-8d0f-9532fcd04d11/image_full.png?alg=HS256&sig=0_u7w_wz2MwQHOXp000ibbQSMRijujyaUu8V3YYPxu4&exp=1729857600" } }, "metadata": [ { "field_type": "select", "field_definition_id": "bfcf8f07-2f7d-413e-99ac-9c4eec9266fa", "field_definition_name": "Fields definition name", "mutable": true, "value": [ { "display_name": "Display name", "id": "6ec91e7f-6411-4bd5-98fe-202662275123" } ], "field_options": [ { "display_name": "Display name", "id": "6ec91e7f-6411-4bd5-98fe-202662275123" }, { "display_name": "Display name 2", "id": "1a2dd824-ce0b-4392-9920-c00108675449" } ] } ], "project": { "created_at": "2024-01-25T19:18:29.614189Z", "description": "Project Description", "id": "3d17f8db-71d7-412b-b3f6-3660dca64b4e", "name": "My Project", "root_folder_id": "5accdd89-c31f-4fdb-8abe-0d2aa9e3af11", "storage": 15000, "updated_at": "2024-02-07T16:44:41.986478Z", "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/", "workspace_id": "d6afb262-b63c-4f5d-a8f0-36fb90837655", "owner": { "active": true, "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN", "email": "user_email@example.com", "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e", "name": "Jon Doe" } } }, "id": "67b11ddd-fadc-45f0-ac1d-2f8ae929126c", "name": "asset.png", "parent_id": "06dd2657-2d56-4c80-afcc-482284725745", "project_id": "abdc8443-a4a1-4179-b052-00fe593c841e", "type": "file", "updated_at": "2024-02-07T16:44:41.986478Z", "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/view/5a89a9fb-0900-4b23-826b-127b90e4db4c", "creator": { "active": true, "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN", "email": "user_email@example.com", "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e", "name": "Jon Doe" }, "metadata": [ { "field_type": "select", "field_definition_id": "bfcf8f07-2f7d-413e-99ac-9c4eec9266fa", "field_definition_name": "Fields definition name", "mutable": true, "value": [ { "display_name": "Display name", "id": "6ec91e7f-6411-4bd5-98fe-202662275123" } ], "field_options": [ { "display_name": "Display name", "id": "6ec91e7f-6411-4bd5-98fe-202662275123" }, { "display_name": "Display name 2", "id": "1a2dd824-ce0b-4392-9920-c00108675449" } ] } ], "project": { "created_at": "2024-01-25T19:18:29.614189Z", "description": "Project Description", "id": "3d17f8db-71d7-412b-b3f6-3660dca64b4e", "name": "My Project", "root_folder_id": "5accdd89-c31f-4fdb-8abe-0d2aa9e3af11", "storage": 15000, "updated_at": "2024-02-07T16:44:41.986478Z", "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/", "workspace_id": "d6afb262-b63c-4f5d-a8f0-36fb90837655", "owner": { "active": true, "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN", "email": "user_email@example.com", "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e", "name": "Jon Doe" } } } ], "links": { "next": "/v4/accounts/1234/workspaces/5678/projects?after=g3QAAAACZAACaWRtAAAAJGFiMmNiY2QzLWFkODQtNDQwMC05YTRkLWE1ZDRkMGE4ZTIxM2QABG5hbWVtAAAACVByb2plY3QgMg==" }, "total_count": 10 } ``` **SDK Code** ```python import requests url = "https://api.frame.io/v4/accounts/6d1c7993-02a2-4391-bd38-ccdb6a7883e9/folders/8d82deba-2b18-426a-bd75-690163923f23/version_stacks" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.frame.io/v4/accounts/6d1c7993-02a2-4391-bd38-ccdb6a7883e9/folders/8d82deba-2b18-426a-bd75-690163923f23/version_stacks'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.frame.io/v4/accounts/6d1c7993-02a2-4391-bd38-ccdb6a7883e9/folders/8d82deba-2b18-426a-bd75-690163923f23/version_stacks" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.frame.io/v4/accounts/6d1c7993-02a2-4391-bd38-ccdb6a7883e9/folders/8d82deba-2b18-426a-bd75-690163923f23/version_stacks") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.frame.io/v4/accounts/6d1c7993-02a2-4391-bd38-ccdb6a7883e9/folders/8d82deba-2b18-426a-bd75-690163923f23/version_stacks") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.frame.io/v4/accounts/6d1c7993-02a2-4391-bd38-ccdb6a7883e9/folders/8d82deba-2b18-426a-bd75-690163923f23/version_stacks', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.frame.io/v4/accounts/6d1c7993-02a2-4391-bd38-ccdb6a7883e9/folders/8d82deba-2b18-426a-bd75-690163923f23/version_stacks"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.frame.io/v4/accounts/6d1c7993-02a2-4391-bd38-ccdb6a7883e9/folders/8d82deba-2b18-426a-bd75-690163923f23/version_stacks")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```