List collections | Frame.io API Documentation

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.collections.index(
    account_id="d7f5110a-f67d-4516-8421-90107a1bd875",
    project_id="7758e221-6044-4317-9af0-beff69a702c7",
)

{
  "data": [
    {
      "aggregation_mode": "dynamic",
      "auto_generated": false,
      "created_at": "2024-02-02T21:19:24.828948Z",
      "description": "Description of collection",
      "id": "3a7c0d51-700c-4f8c-bfbe-dd40b0177827",
      "name": "Test Collection",
      "private": false,
      "project_id": "740e9ef5-47c4-496a-9984-4b5f7d39f031",
      "root_folder_id": "ba4fab51-015a-44d0-8af8-c31312bdcf56",
      "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": "3a7c0d51-700c-4f8c-bfbe-dd40b0177827",
      "name": "Test Collection",
      "private": false,
      "project_id": "740e9ef5-47c4-496a-9984-4b5f7d39f031",
      "root_folder_id": "ba4fab51-015a-44d0-8af8-c31312bdcf56",
      "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": "fc166901-1b13-49d7-b9c0-c35741e898d3",
        "name": "My Project",
        "root_folder_id": "c49b3469-7424-4837-a755-daa5f9adc83d",
        "status": "active",
        "storage": 15000,
        "updated_at": "2024-02-07T16:44:41.986478Z",
        "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/",
        "workspace_id": "33798d82-c243-4b4a-a609-5b5b0226923a",
        "adobe_id": "urn:aaid:sc:US:9f4e4d7a-4b6b-4c4f-9f00-b31a91cfc6f3",
        "restricted": false
      },
      "shares": [
        {
          "access": "public",
          "collection_id": "ade04178-4a5a-4931-96f8-b763d1472477",
          "commenting_enabled": true,
          "created_at": "2024-02-02T21:19:24.828948Z",
          "description": "Description of share",
          "downloading_enabled": true,
          "enabled": true,
          "expiration": "2026-06-02T00:54:49.376288Z",
          "id": "779bbc5c-c338-4d70-b771-f123b53fdab1",
          "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/123/projects/123/collections"
  },
  "total_count": 10
}

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

認証

AuthorizationBearer

Bearer <token>形式のBearer認証。tokenは認証トークンです。

パスパラメータ

account_idstring必須形式: "uuid"

A UUID string that uniquely identifies a Frame.io entity.

project_idstring必須形式: "uuid"

A UUID string that uniquely identifies a Frame.io entity.

クエリパラメータ

includestringオプション

Include query parameter for collections

afterstringオプション

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_sizeintegerオプション1-100デフォルト値 50

Page size query param for requests

include_total_countbooleanオプションデフォルト値 false

Page query param to include the count of all entities

レスポンスヘッダー

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

レスポンス

datalist of objects

Collections

linksobject

Links to paginated data

total_countinteger or null

Total count

エラー

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error