Listar coleções | Frame.io API Documentation

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.collections.index(
    account_id="58d9fe45-5631-4cb9-bbd4-ae29ebb9b07e",
    project_id="47eddd7b-e86e-4771-a612-a5bf1d41d21b",
)

{
  "data": [
    {
      "aggregation_mode": "dynamic",
      "auto_generated": false,
      "created_at": "2024-02-02T21:19:24.828948Z",
      "description": "Description of collection",
      "id": "8ac0bb28-bda9-45bf-af08-20bdb164517e",
      "name": "Test Collection",
      "private": false,
      "project_id": "5618389c-590c-4bb7-b898-ae4907b666cd",
      "root_folder_id": "5f870a71-f77b-409a-928f-05803b56df48",
      "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": "8ac0bb28-bda9-45bf-af08-20bdb164517e",
      "name": "Test Collection",
      "private": false,
      "project_id": "5618389c-590c-4bb7-b898-ae4907b666cd",
      "root_folder_id": "5f870a71-f77b-409a-928f-05803b56df48",
      "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": "90d3f72c-abed-463f-8d1b-1c3c084556e1",
        "name": "My Project",
        "root_folder_id": "a8426cb1-5056-4010-92d0-416e2c0d3a78",
        "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": "f9cc69f8-c0f8-4176-9eb1-3049c4b6b647",
        "adobe_id": "urn:aaid:sc:US:9f4e4d7a-4b6b-4c4f-9f00-b31a91cfc6f3",
        "restricted": false
      },
      "shares": [
        {
          "access": "public",
          "collection_id": "448ea0ea-07b5-4661-b99d-fc13d2f08a8a",
          "commenting_enabled": true,
          "created_at": "2024-02-02T21:19:24.828948Z",
          "description": "Description of share",
          "downloading_enabled": true,
          "enabled": true,
          "expiration": "2026-07-29T22:27:14.065683Z",
          "id": "a9f1d346-aaa3-4de0-bab8-feeb394ad9a8",
          "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
}

Listar coleções de um projeto.
Limites de taxa: 100 chamadas por 1,00 minuto por account_user

Autenticação

AuthorizationBearer

Autenticação bearer na forma Bearer <token>, onde token é seu token de autenticação.

Parâmetros de caminho

account_idstringObrigatórioformat: "uuid"

Uma string UUID que identifica de forma exclusiva uma entidade do Frame.io.

project_idstringObrigatórioformat: "uuid"

Uma string UUID que identifica de forma exclusiva uma entidade do Frame.io.

Parâmetros de consulta

includestringOpcional

Incluir parâmetro de consulta para coleções

afterstringOpcional

Parâmetro de consulta Cursor opaco para solicitações que retornam resultados paginados.
OBSERVAÇÃO: este valor é gerado automaticamente e incluído como parte dos links de uma resposta anterior. Ele não foi projetado para ser legível por humanos.

page_sizeintegerOpcional1-100Padrão é 50

Parâmetro de consulta de tamanho da página para solicitações

include_total_countbooleanOpcionalPadrão é false

Parâmetro de consulta de página para incluir a contagem de todas as entidades

Cabeçalhos de resposta

x-ratelimit-limitinteger

Limite de taxa

x-ratelimit-remaininginteger

Limite de taxa restante

x-ratelimit-windowinteger

Janela do limite de taxa em milissegundos

Resposta

datalist of objects

Coleções

linksobject

Links para dados paginados

total_countinteger or nullOpcional

Contagem total

Erros

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