> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.staging.frame.io/platform/v4-experimental/api-reference/collections/index/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.staging.frame.io/_mcp/server.

# List collections

GET https://api.frame.io/v4/accounts/{account_id}/projects/{project_id}/collections

List collections for a project. Rate Limits: 100 calls per 1.00 minute(s) per account\_user

Reference: https://developer.staging.frame.io/platform/v4-experimental/api-reference/collections/index

## Request

### Path parameters

- `account_id` (string, required)
- `project_id` (string, required)

### Query parameters

- `include` (string, optional)
- `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)

### Headers

- `api-version` (enum, required)
  - Allowed values: `experimental`

## Response

### 200

OK

- `data` (list of Collection, required) — Collections
- `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

### Collection

- `aggregation_mode` (enum, required)
  - Allowed values: `static`, `dynamic`
- `auto_generated` (boolean, required)
- `created_at` (string, required) — Creation timestamp
- `description` (string, required, nullable) — Collection description
- `id` (string, required) — Collection ID
- `name` (string, required, nullable) — Collection name
- `private` (boolean, required)
- `project_id` (string, required) — Project ID
- `root_folder_id` (string, required, nullable) — Root folder ID
- `updated_at` (string, required) — Update timestamp
- `creator` (User, optional) — User details
- `project` (Project, optional) — Frame.io Project
- `shares` (list of Share, optional) — Shares

### 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)

### 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

### Project

Frame.io Project

- `created_at` (string, required) — Created Timestamp
- `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

### Share

- `access` (enum, required)
  - Allowed values: `public`, `secure`
- `collection_id` (string, required) — Collection ID
- `commenting_enabled` (boolean, required)
- `created_at` (string, required) — Creation timestamp
- `description` (string, required, nullable) — Share description
- `downloading_enabled` (boolean, required)
- `enabled` (boolean, required)
- `expiration` (string, required, nullable) — Expiration timestamp
- `id` (string, required) — Share ID
- `last_viewed_at` (string, required, nullable) — Last viewed timestamp
- `name` (string, required, nullable) — Share name
- `short_url` (string, required, nullable) — Share URL
- `updated_at` (string, required) — Update timestamp
- `passphrase` (string, optional, nullable) — Passphrase to access share, if passphrase is required and not given it will be generated

### BadRequestErrorsItemsSource

- `pointer` (string, optional)

### UnauthorizedErrorsItemsSource

- `pointer` (string, optional)

### ForbiddenErrorsItemsSource

- `pointer` (string, optional)

### NotFoundErrorsItemsSource

- `pointer` (string, optional)

### UnprocessableEntityErrorsItemsSource

- `pointer` (string, optional)

### TooManyRequestsErrorsItemsSource

- `pointer` (string, optional)

## Examples

**Response**

```json
{
  "data": [
    {
      "aggregation_mode": "dynamic",
      "auto_generated": false,
      "created_at": "2024-02-02T21:19:24.828948Z",
      "description": "Description of collection",
      "id": "7b10bc38-b17c-4c29-abdc-6f78ae61ee33",
      "name": "Test Collection",
      "private": false,
      "project_id": "8aacb3e6-30b3-4ef8-a770-803a70b6e29c",
      "root_folder_id": "99422c6c-250a-411f-9759-8a4b3e325686",
      "updated_at": "2024-02-02T21:19:24.828948Z"
    },
    {
      "aggregation_mode": "dynamic",
      "auto_generated": false,
      "created_at": "2024-02-02T21:19:24.828948Z",
      "description": "Description of collection",
      "id": "7b10bc38-b17c-4c29-abdc-6f78ae61ee33",
      "name": "Test Collection",
      "private": false,
      "project_id": "8aacb3e6-30b3-4ef8-a770-803a70b6e29c",
      "root_folder_id": "99422c6c-250a-411f-9759-8a4b3e325686",
      "updated_at": "2024-02-02T21:19:24.828948Z",
      "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"
      },
      "project": {
        "created_at": "2024-01-25T19:18:29.614189Z",
        "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"
      },
      "shares": [
        {
          "access": "public",
          "collection_id": "b3252929-2bd2-4b7b-9db2-7e7e8f798284",
          "commenting_enabled": true,
          "created_at": "2024-02-02T21:19:24.828948Z",
          "description": "Description of share",
          "downloading_enabled": true,
          "enabled": true,
          "expiration": "2025-10-24T22:42:23.690532Z",
          "id": "e92216a0-4497-4980-9f35-4c480a926139",
          "last_viewed_at": "2024-03-02T21:19:24.828948Z",
          "name": "Test Share",
          "short_url": "https://f.io/GGa9wPw5",
          "updated_at": "2024-02-02T21:19:24.828948Z",
          "passphrase": "as!dfj39sd(*"
        }
      ]
    }
  ],
  "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/9b48ec7f-1b84-4952-b534-aa31c8f2481a/projects/71309e87-50e7-49be-ae64-018459b756be/collections"

headers = {"api-version": "experimental"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.frame.io/v4/accounts/9b48ec7f-1b84-4952-b534-aa31c8f2481a/projects/71309e87-50e7-49be-ae64-018459b756be/collections';
const options = {method: 'GET', headers: {'api-version': 'experimental'}};

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/9b48ec7f-1b84-4952-b534-aa31c8f2481a/projects/71309e87-50e7-49be-ae64-018459b756be/collections"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api-version", "experimental")

	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/9b48ec7f-1b84-4952-b534-aa31c8f2481a/projects/71309e87-50e7-49be-ae64-018459b756be/collections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api-version"] = 'experimental'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.frame.io/v4/accounts/9b48ec7f-1b84-4952-b534-aa31c8f2481a/projects/71309e87-50e7-49be-ae64-018459b756be/collections")
  .header("api-version", "experimental")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.frame.io/v4/accounts/9b48ec7f-1b84-4952-b534-aa31c8f2481a/projects/71309e87-50e7-49be-ae64-018459b756be/collections', [
  'headers' => [
    'api-version' => 'experimental',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.frame.io/v4/accounts/9b48ec7f-1b84-4952-b534-aa31c8f2481a/projects/71309e87-50e7-49be-ae64-018459b756be/collections");
var request = new RestRequest(Method.GET);
request.AddHeader("api-version", "experimental");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["api-version": "experimental"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.frame.io/v4/accounts/9b48ec7f-1b84-4952-b534-aa31c8f2481a/projects/71309e87-50e7-49be-ae64-018459b756be/collections")! 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()
```